25 lines
1.2 KiB
Markdown
25 lines
1.2 KiB
Markdown
|
|
||
|
|
# Contributing Guidelines
|
||
|
|
|
||
|
|
Thank you for considering contributing to our project! Please read the following guidelines before making your contribution.
|
||
|
|
|
||
|
|
### New Feature Pull Requests
|
||
|
|
|
||
|
|
- To contribute a new feature, please make sure to send your pull request to the `dev` branch.
|
||
|
|
- Your pull request should include a detailed description of the new feature you are adding and any relevant documentation.
|
||
|
|
- Please also make sure your code follows PEP8 standards.
|
||
|
|
|
||
|
|
### Bugfix Pull Requests
|
||
|
|
|
||
|
|
- If you are fixing a bug or issue, please send your pull request to the `main` branch.
|
||
|
|
- Describe the bug or issue that you are fixing in your pull request and include any relevant information.
|
||
|
|
- Make sure to test your fix thoroughly and include any necessary documentation.
|
||
|
|
|
||
|
|
### General Guidelines
|
||
|
|
|
||
|
|
- Please make sure to be a good person in all interactions and contributions.
|
||
|
|
- Be respectful and polite when communicating with other contributors and maintain a positive and constructive attitude.
|
||
|
|
- If you have any questions or need help with your contribution, feel free to reach out to our team.
|
||
|
|
|
||
|
|
We appreciate your interest in improving our project and look forward to reviewing your contributions!
|