First off, thank you for considering contributing to this project.
Before submitting an issue, please check the issue tracker to ensure that the issue hasn't already been reported. If you find your issue already reported, you can subscribe to that issue to receive updates. If you have any additional information to add, please comment on the issue. If the issue is unnasigned and you'd like to contribute, assign the issue to yourself.
If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question.
If you don't see your idea listed, and you think it fits into the goals of this project, do one of the following:
- If your contribution is minor, such as a typo fix, open a pull request.
- If your contribution is major, or you have not yet decided how to implement your idea, open an issue to discuss it. This allows other contributors to point out any potential flaws or to help you flesh out your idea.
- Fork the repository and create your branch from
main. - Write some code
- Make sure your code lints.
- Issue that pull request!
Write meaningful commit messages that provide insight into the changes made.
If you find a bug, please report it in the issue tracker with a detailed description.
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. Please provide as much detail and context as possible.
By contributing to this project, you agree that your contributions will be licensed under MIT.
Your contributions are sincerely appreciated. We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
Thank you for your interest in contributing