Contributions are welcome, and they are greatly appreciated!
Every little bit helps, and credit will always be given.
Create a new project issue! Try to be as descriptive as possible.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Create a new merge/pull request! Make sure to follow the guidelines.
Look through the GitHub issues for features, bugs and other requests. Anything tagged with "help wanted" is open to whoever wants to implement it.
Before you submit a pull request, check that it meets these guidelines:
- Make sure to have atomic commits and contextual commit messages! Check out this awesome blog post by Chris Beams for more information.
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated:
- Put your new functionality into a function with a docstring
- Add the feature to the list in README.md.