Skip to content

Commit 77b3ad5

Browse files
committed
Update readme
1 parent 8d271f3 commit 77b3ad5

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ You can install this repository with `pip`, either clone it and run `pip install
3535
The code is linted with `ruff .`, type checked with `mypy src`, and tested with `pytest`. These all run in CI with GitHub Actions. The codebase is not even `v0.1` yet so it's still subject to summary rearrangement.
3636

3737
Dependencies are defined in `pyproject.toml` and can be compiled to `dev-requirements.txt` with:
38-
3938
```
4039
uv pip compile --extra dev --extra server pyproject.toml --output-file dev-requirements.txt
4140
```
42-
4341
If you're not using `uv`, just regular `pip-compile` from `pip-tools` will do the same thing.
4442

43+
All changes to the codebase should go via pull requests, and should only be merged once all the checks in the `test` job are passing. It is preferable to merge code where the `test-with-unpinned-dependencies` job fails, and deal with the dependency issues in another PR, particularly where the required changes are distinct from the code in the PR.
44+
4545
## Demo
4646

4747
See the [examples folder](./examples/) for a runnable demo.

0 commit comments

Comments
 (0)