aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: d965adad0ce5d1cc12372cb844eaebf444ab0fed (plain) (blame)
1
2
3
4
5
6
7
8
9
10
# Thallium

# Contributing
Run `make` from the project root to both install this project's dependencies & install the pre-commit hooks.
- This requires both [make](https://www.gnu.org/software/make/) & [poetry](https://python-poetry.org/) to be installed.

## Other make targets
- `make lint` will run the pre-commit linting against all files in the repository
- `make lock` wil relock project dependencies, install them to your environment, and update the [`requirements.txt`](./requirements.txt) file with production dependencies
- `make test` / `make retest` will run the test suite. `retest` will only run the tests that failed on the last test run.