Contributions are encouraged and greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
If you are reporting a bug or issues, please include:
- Operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting
- Detailed steps to reproduce the bug.
Check the Issues for this repo on GitHub. Anything tagged with a "bug" ticket type is open to whoever wants to implement it.
Please file an issue or check the issues for this repo on GitHub. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
Once issues are posted and triaged please include their issue number in any PRs related to that work
Submissions and README.md files could always use more documentation. Documentation can always use an update or tweak in the official docs, in docstrings of scripts, comments in configs, or anywhere a bit of clarity may be useful..
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include documentation and example changes for any new functionality.
- If the pull request adds functionality, the tests should be updated.