Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.
We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look at the links below if you're not sure how to open a PR.
Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you.
- Fork and clone the repository.
- Create a new branch:
git checkout -b my-branch-name. - Configure and install the dependencies:
poetry install. - Make sure the tests pass on your machine:
make install & make tests - Make your change, add tests, and make sure the tests still pass.
- Push to your fork and submit a pull request and complete the information in the pull request template.
using make install & make tests will also run the following linters:
- Black: The uncompromising Python code formatter
- isort your imports, so you don't have to
- flake8: Your Tool For Style Guide Enforcement
using make format will run isort and black and apply any formatting suggestions from them