Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
11 lines (9 loc) · 668 Bytes

CONTRIBUTING.md

File metadata and controls

11 lines (9 loc) · 668 Bytes

Contributing

This package is open to contributions. To contribute, please follow these steps:

  1. Fork the upstream repository into your personal account.
  2. Install poetry, and install project 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 this repository with a detailed summary of your changes and what motivated the change