First, thanks for taking the time to contribute to our project! There are many ways you can help out.
If you have a question that needs an answer, create an issue.
If you encounter any bugs in the code, or want to request a new feature or enhancement, please create an issue to report it. Please use the appropriate issue template.
We welcome your pull requests for bug fixes. To implement something new, please create an issue first so we can discuss it together, then:
- Fork the repo and create your branch from
main - Code your bug fix or new feature, please follow best practices and try to stay consistent with existing code and Git commit messages
- If you've added code that should be tested, add tests
- If necessary, update the documentation
- Ensure the test suite passes
- Make sure your code lints
When your code is ready to be submitted, submit a pull request to begin the code review process.
Any contributions you make will be under the GNU General Public License.
We encourage professional and inclusive interactions on our project. We welcome everyone to open an issue, improve the documentation, report a bug or submit a pull request. By participating in this project, you agree to abide by the project's code of conduct.