Skip to content

Latest commit

History

History
19 lines (15 loc) 路 1.02 KB

CONTRIBUTING.md

File metadata and controls

19 lines (15 loc) 路 1.02 KB

Contributing

This package is open to contributions 馃憦

To contribute, please follow these steps:

  1. Create an issue explaining what you'd like to fix or add. This way, we can approve and discuss the solution before any time is spent on developing it.
  2. Fork the upstream repository into a personal account.
  3. Install poetry, and install all dependencies using poetry install
  4. Activate the environment by running poetry shell
  5. Install pre-commit (for project linting) by running pre-commit install
  6. Create a new branch for your changes, and make sure to add tests!
  7. Push the topic branch to your personal fork
  8. Run pre-commit run --all-files locally to ensure proper linting
  9. Create a pull request to the Intility repository with a detailed summary of your changes and what motivated the change

If you need a more detailed walk through, please see this issue comment.