Skip to content

CONTRIBUTING

Contributing

Hi there! We're thrilled that you'd like to contribute to this project.

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.

Issues and PRs

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.

Submitting a pull request

  1. Fork and clone the repository.
  2. Configure and install the dependencies: pip3 install -r requirements.txt.
  3. Create a new branch: git checkout -b my-branch-name.
  4. Make your change, add tests, and make sure the tests still pass.
  5. Push to your fork and submit a pull request.
  6. Pat your self on the back and wait for your pull request to be reviewed and merged.

Resources