Skip to content

Commit 7d84b8a

Browse files
committed
Add contribute
1 parent add0cca commit 7d84b8a

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing
2+
3+
We welcome contributions to this project! Here are some guidelines to follow:
4+
5+
## Reporting Bugs
6+
7+
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.
8+
9+
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.
10+
11+
## Suggesting Enhancements
12+
13+
We also welcome enhancement suggestions! Please explain in detail how the enhancement would work and why you think it would be useful to add.
14+
15+
## Pull Requests
16+
17+
If you would like to contribute code:
18+
19+
1. Fork the repository
20+
2. Clone your fork locally
21+
3. Create a new branch
22+
4. Make your changes and commit them with clear commit messages
23+
5. Push your branch to your fork
24+
6. Open a pull request against the main repository
25+
26+
Pull requests should:
27+
28+
- Address only one issue or add one feature
29+
- Update docs and tests accordingly
30+
- Follow the existing code style
31+
- Pass all CI checks
32+
33+
We will review the pull request as soon as possible. Thank you for contributing!
34+
35+
## Code of Conduct
36+
37+
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.

0 commit comments

Comments
 (0)