@@ -16,9 +16,9 @@ what actions will and will not be tolerated.
1616- The project uses python3.11 or higher and [ uv] ( https://docs.astral.sh/uv/getting-started/installation/ )
1717- Python code should conform to the
1818 [ PEP-8 style guidelines] ( https://www.python.org/dev/peps/pep-0008/ )
19- whenever possible.
19+ whenever possible, and formatted using ` make fmt ` .
2020- Where feasible, include unit tests.
21- - Tests should make use of the testing fixtures and tools on offer
21+ - Tests should make use of the fixtures and tools available in the project.
2222- Code should pass ` make lint ` with no warnings.
2323
2424### Getting started
@@ -39,6 +39,12 @@ make deps
3939make lint
4040```
4141
42+ ### Formatting code
43+
44+ ``` bash
45+ make lint
46+ ```
47+
4248### Executing tests
4349
4450``` bash
@@ -64,8 +70,9 @@ Before working on a pull request which makes significant change, consider openin
64703 . If you've changed APIs, update the documentation.
65714 . Ensure the test suite passes.
6672 - This can be done with ` make test `
67- 5 . Make sure your code lints.
68- - This can be done with ` make lint `
73+ 5 . Ensure code lints and is formatted correctly.
74+ - This can be done with ` make fmt ` and ` make lint `
75+ - ` make lint.fix ` will attempt to resolve linting issues.
69766 . If you haven't already, complete the Contributor License Agreement ("CLA").
7077
7178## Contributor License Agreement ("CLA")
0 commit comments