Contributions are very welcome! Any existing issues labeled "help wanted" or "good first issue" are free to be pursued.
For feature requests and bug reports, submit an issue.
We follow PEP8 as the general style guide with the following changes:
- Line length can be up to 120 characters long
- Double quotes for all strings except when avoiding backslashes
We use flake8 for linting and pytest with tox for testing.
The preferred way to contribute is to fork the main repository on GitHub.
-
Discuss your proposed change in a GitHub issue first before spending time and implementing a feature or fix.
-
Ensure all changes are relevant to the pull request. Keep pull requests as small and to-the-point as possible.
-
Add & modify tests as necessary. Also, ensure the code meets our style standards.
-
Once changes are completed, open a pull request for review against the master branch.