|
5 | 5 | return type hints of None), but type hints are not needed when initializing variables. |
6 | 6 | - We use uv for everything (e.g. we do `uv run python ...` to run some python code, and |
7 | 7 | `uv run pytest tests/unit` to run unit tests). Please prefer `uv run python -c ...` over |
8 | | - `python3 -c ...` |
| 8 | + `python3 -c ...`. |
| 9 | +- To test the usage examples, run `uv run make doctest -C docs`. |
9 | 10 | - After generating code, please run `uv run ty check`, `uv run ruff check` and `uv run ruff format`. |
10 | 11 | Fix any error. |
11 | | -- After changing anything in `src` or in `tests/unit` or `tests/doc`, please identify the affected |
12 | | - test files in `tests/` and run them with e.g. |
13 | | - `uv run pytest tests/unit/aggregation/test_upgrad.py -W error`. Fix any error, either in the |
14 | | - changes you've made or by adapting the tests to the new specifications. |
| 12 | +- After changing anything in `src` or in `tests/unit`, please identify the affected test files in |
| 13 | + `tests/` and run them with e.g. `uv run pytest tests/unit/aggregation/test_upgrad.py -W error`. |
| 14 | + Fix any error, either in the changes you've made or by adapting the tests to the new |
| 15 | + specifications. |
| 16 | +- If you create new user-facing content, add a `.rst` file in `docs/source` and link to it |
| 17 | + appropriately. |
| 18 | +- If you make any change that affects the documentation (e.g. docstring or `.rst` files), verify |
| 19 | + that the documentation can be built by running |
| 20 | + `uv run make clean -C docs; uv run make html -C docs`. |
| 21 | +- Prefix protected functions and modules with '_'. |
| 22 | +- Always follow SOLID principles when implementing stuff, and in particular the single |
| 23 | + responsibility principle and the Liskov substitution principle. |
0 commit comments