Contributing

Contributions are welcome! To get setup for development, follow the instructions below.

Setup

Make sure you have poetry installed, clone the repository, and install dependencies with:

git clone https://github.com/jbloomAus/SAELens.git # we recommend you make a fork for submitting PR's and clone that!
poetry lock # can take a while.
poetry install 
make check-ci # validate the install

Testing, Linting, and Formatting

This project uses pytest for testing, pyright for type-checking, and Ruff for formatting and linting.

If you add new code, it would be greatly appreciated if you could add tests in the tests directory. You can run the tests with:

make test

Before commiting, make sure you format the code with:

make format

Finally, run all CI checks locally with:

make check-ci

If these pass, you're good to go! Open a pull request with your changes.

Documentation

This project uses mkdocs for documentation. You can see the docs locally with:

make docs-serve

If you make changes to code which requires updating documentation, it would be greatly appreciated if you could update the docs as well.