Contributing

August 26, 2021 ยท View on GitHub

This package is open to contributions ๐Ÿ‘

To contribute, please follow these steps:

  1. Fork the upstream repository into a personal account.
  2. Install poetry, and install all dependencies using poetry install
  3. Install pre-commit (for project linting) by running pre-commit install
  4. Create a new branch for your changes, and make sure to add tests!
  5. Push the topic branch to your personal fork
  6. Run pre-commit run --all-files locally to ensure proper linting
  7. Create a pull request to the snok repository with a detailed summary of your changes and what motivated the change