Skip to content

Latest commit

 

History

History
12 lines (10 loc) · 576 Bytes

CONTRIBUTING.md

File metadata and controls

12 lines (10 loc) · 576 Bytes

Guidelines for contribution

  1. Clone the repo
  2. Install package in editable mode pip install -e .[dev], including development dependencies
  3. If you are fixing a bug, first add a failing test
  4. Make changes
  5. Verify that all tests passes by running pytest from the package root directory
  6. Format the code by running black (pip install black==22.3.0) e.g. black nameofthefiletoformat.py
  7. Make a pull request with a summary of the changes

Tests can also be run with tools like VS Code testing