We welcome your contributions! There are multiple ways to contribute.
- Code of Conduct
- How to Contribute
- Reporting Bugs
- Requesting Features
- Submitting Pull Requests
- Testing
- Documentation
Please review our Code of Conduct before participating in our community. We want all contributors to feel welcome and to foster an open and inclusive environment.
We welcome contributions in the form of bug reports, feature requests, code changes, and documentation improvements. Here's how you can contribute:
- Fork the repository to your GitHub account.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them with a clear and concise commit message.
- Push your changes to your branch.
- Submit a pull request to the main repository.
Please follow our Pull Request Template when submitting a pull request.
If you find a bug, please open an issue with a detailed description of the problem. Include information about your environment and steps to reproduce the issue. When filing a bug remember that the better written the bug is, the more likely it is to be fixed. Please follow our Bug Report Template when submitting a pull request.
We encourage you to open an issue to propose new features or improvements. Please provide as much detail as possible about your suggestion. Please follow our Feature Request Template when submitting a pull request.
When submitting a pull request, please ensure the following:
- You have added or updated relevant documentation.
- Tests (if applicable) have been added or updated.
- Your branch is up-to-date with the main repository.
- The pull request title and description are clear and concise.
Ensure that your changes pass all existing tests and consider adding new tests if applicable.
Improvements to the documentation are always welcome. If you find areas that need clarification or additional information, please submit a pull request.