Skip to content

Commit

Permalink
chore: Update CONTRIBUTING.md with a more detailed contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
miguoliang committed Jun 14, 2024
1 parent 6440290 commit d302a0c
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,17 @@
Thank you for considering contributing to the Tomato Clock CLI project! We appreciate your interest and support. This guide will help you get started with contributing to our project.

## Table of Contents
- [Getting Started](#getting-started)
- [Submitting Issues](#submitting-issues)
- [Making Pull Requests](#making-pull-requests)
- [Code of Conduct](#code-of-conduct)
- [License](#license)

- [Contributing Guide](#contributing-guide)
- [Table of Contents](#table-of-contents)
- [Getting Started](#getting-started)
- [Submitting Issues](#submitting-issues)
- [Making Pull Requests](#making-pull-requests)
- [Code of Conduct](#code-of-conduct)
- [License](#license)

## Getting Started

To contribute to the Tomato Clock CLI project, please follow these steps:

1. Fork the repository on GitHub.
Expand All @@ -22,6 +26,7 @@ To contribute to the Tomato Clock CLI project, please follow these steps:
8. Submit a pull request to the main repository.

## Submitting Issues

If you encounter any issues or bugs while using the Tomato Clock CLI, please follow these steps to submit an issue:

1. Go to the [issue tracker](https://github.com/your-username/tomato-clock-cli/issues) on GitHub.
Expand All @@ -33,6 +38,7 @@ If you encounter any issues or bugs while using the Tomato Clock CLI, please fol
7. Click on the "Submit New Issue" button.

## Making Pull Requests

To contribute code changes or new features to the Tomato Clock CLI, please follow these steps:

1. Ensure that your local repository is up to date with the main repository.
Expand All @@ -44,9 +50,11 @@ To contribute code changes or new features to the Tomato Clock CLI, please follo
7. Submit a pull request to the main repository.

## Code of Conduct

Please note that we have a Code of Conduct in place to ensure a positive and inclusive community. By participating in this project, you agree to abide by the Code of Conduct. Violations may result in temporary or permanent exclusion from the project.

## License

The Tomato Clock CLI project is licensed under the [MIT License](https://opensource.org/licenses/MIT). By contributing to this project, you agree to license your contributions under the same license.

We appreciate your contributions and look forward to your involvement in the Tomato Clock CLI project!

0 comments on commit d302a0c

Please sign in to comment.