-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
73ee102
commit 64734ea
Showing
1 changed file
with
53 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
## How to Contribute | ||
|
||
We welcome all types of contributions, including bug fixes, new features, documentation, and more. Here are some guidelines to follow: | ||
|
||
### Bug Fixes | ||
|
||
If you find a bug, please do the following: | ||
|
||
1. Check the issue tracker to see if the bug has already been reported | ||
2. If the bug hasn't been reported, please create a new issue | ||
3. Fork the repository and create a new branch for your fix | ||
4. Make your changes on the new branch | ||
5. Test your changes thoroughly | ||
6. Push your changes to your forked repository | ||
7. Submit a pull request to the main repository | ||
|
||
### New Features | ||
|
||
If you have an idea for a new feature, please do the following: | ||
|
||
1. Check the issue tracker to see if the feature has already been requested | ||
2. If the feature hasn't been requested, please create a new issue | ||
3. Fork the repository and create a new branch for your feature | ||
4. Make your changes on the new branch | ||
5. Test your changes thoroughly | ||
6. Push your changes to your forked repository | ||
7. Submit a pull request to the main repository | ||
|
||
### Documentation | ||
|
||
If you would like to contribute documentation, please do the following: | ||
|
||
1. Fork the repository and create a new branch for your documentation changes | ||
2. Make your changes on the new branch | ||
3. Test your changes thoroughly | ||
4. Push your changes to your forked repository | ||
5. Submit a pull request to the main repository | ||
|
||
## Pull Request Guidelines | ||
|
||
When submitting a pull request, please make sure to do the following: | ||
|
||
1. Include a detailed description of your changes | ||
2. Reference any relevant issues or pull requests | ||
3. Ensure your code follows our coding standards | ||
4. Test your changes thoroughly | ||
5. Ensure there are no merge conflicts | ||
|
||
## Code Review | ||
|
||
All pull requests will be reviewed by one or more maintainers. We may provide feedback or request changes to ensure the changes are high-quality and fit with the project's goals. | ||
|
||
Thank you for considering contributing to \[Project Name\]! We appreciate your time and effort. |