- Report Bugs: Submit an issue describing the bug and how to reproduce it.
- Suggest Enhancements: Submit an issue with your suggestion.
- Submit Fixes or Features: Send a pull request with your changes.
Before submitting a bug report, please check the existing issues to ensure the bug hasn't already been reported. If you find your issue already reported, you can add a comment with more information.
If you're unable to find an open issue addressing the problem, open a new one. Include a clear title, a detailed description, and as much relevant information as possible.
Enhancement suggestions are welcome. Please submit an issue to discuss your suggestion before making any changes. This helps others to understand the enhancement you're proposing and to give feedback.
- Fork the repository and create your branch from
master. - If you've added code, add tests to ensure your contribution doesn't introduce unexpected bugs.
- Ensure the test suite passes.
- Make sure your code lints.
- Update the README.md if necessary.
- Describe your Pull Request with as many details as possible.
- Submit your Pull Request.
- Write clean code with comments when necessary.
- Follow the existing coding style as much as possible.
- Use meaningful commit messages.
- Update the documentation with any changes in the API.