-
-
Notifications
You must be signed in to change notification settings - Fork 2
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
Showing
1 changed file
with
37 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,37 @@ | ||
# Contributing | ||
|
||
We welcome contributions to this project! Here are some guidelines to follow: | ||
|
||
## Reporting Bugs | ||
|
||
Before submitting a bug report, please check the issue tracker to see if the issue has already been reported. If it has, please add any additional info you have to the existing issue. | ||
|
||
If the issue has not been reported, open a new issue and provide as much detail as possible about the bug and how to reproduce it. | ||
|
||
## Suggesting Enhancements | ||
|
||
We also welcome enhancement suggestions! Please explain in detail how the enhancement would work and why you think it would be useful to add. | ||
|
||
## Pull Requests | ||
|
||
If you would like to contribute code: | ||
|
||
1. Fork the repository | ||
2. Clone your fork locally | ||
3. Create a new branch | ||
4. Make your changes and commit them with clear commit messages | ||
5. Push your branch to your fork | ||
6. Open a pull request against the main repository | ||
|
||
Pull requests should: | ||
|
||
- Address only one issue or add one feature | ||
- Update docs and tests accordingly | ||
- Follow the existing code style | ||
- Pass all CI checks | ||
|
||
We will review the pull request as soon as possible. Thank you for contributing! | ||
|
||
## Code of Conduct | ||
|
||
Please note that this project has a [Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms. |