diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 27668843..0f546c0f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,5 +1,5 @@ [ ] Add tests for the change. In general, aim for full test coverage at the Python level. Rust tests are optional. [ ] Add any appropriate documentation. -[ ] Add a summary of changes to `CHANGELOG.rst`. +[ ] Add a summary of changes to the `latest` section at the top of `CHANGELOG.rst`. (If it's not there, add it.) [ ] Add your name to `AUTHORS.rst`. [ ] Run `just full-check`. \ No newline at end of file diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 69f6f18b..ddc6c91f 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -3,9 +3,10 @@ Changelog ========= latest ----------------- +------ * Improve contribution experience for Windows developers using Just. +* Tweak Just commands for running version-specific Python tests. 3.14 (2025-12-10) ----------------- diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 0e320edf..a6852951 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -40,7 +40,14 @@ Before requesting a review - Ensure you have included tests that cover the change. In general, aim for full test coverage at the Python level. Rust tests are optional. - Update documentation when there's a new API, functionality etc. -- Add a note to ``CHANGELOG.rst`` about the changes. +- Add a note to ``CHANGELOG.rst`` about the changes, in the imperative mood. This should go under + the main page title, under a ``latest`` section. If it's not there already, create it. E.g.:: + + latest + ------ + + * Add new feature. + - Add yourself to ``AUTHORS.rst``. - Run ``just full-check`` locally. (If you're a new contributor, CI checks are not run automatically.) @@ -99,7 +106,7 @@ Typical workflow (changes that involve Rust): 1. Make a change to Rust code. 2. Run ``just compile-and-test``. This will compile the Rust code, then run Rust and Python tests in the default version. -There are also version-specific test commands (e.g. ``just test-3-14``) - run ``just help`` to see which ones. +You can also run tests under specific Python versions by passing the version, e.g. ``just test-python 3.14``. Working with documentation -------------------------- diff --git a/justfile b/justfile index 79489aee..3d78fc06 100644 --- a/justfile +++ b/justfile @@ -25,44 +25,20 @@ compile-and-test: test-rust: @cargo test --no-default-features -# Runs tests under the default Python version. +# Runs Python tests. [group('testing')] -test-python: +test-python $UV_PYTHON=env("UV_PYTHON", ""): @uv run pytest --benchmark-skip # Runs tests under all supported Python versions, plus Rust. [group('testing')] -test-all: test-python-3-9 test-python-3-10 test-python-3-11 test-python-3-12 test-python-3-13 test-python-3-14 test-rust - -# Runs tests under Python 3.9. -[group('testing')] -test-python-3-9: - UV_PYTHON=3.9 just test-python - -# Runs tests under Python 3.10. -[group('testing')] -test-python-3-10: - UV_PYTHON=3.10 just test-python - -# Runs tests under Python 3.11. -[group('testing')] -test-python-3-11: - UV_PYTHON=3.11 just test-python - -# Runs tests under Python 3.12. -[group('testing')] -test-python-3-12: - UV_PYTHON=3.12 just test-python - -# Runs tests under Python 3.13. -[group('testing')] -test-python-3-13: - UV_PYTHON=3.13 just test-python - -# Runs tests under Python 3.14. -[group('testing')] -test-python-3-14: - UV_PYTHON=3.14 just test-python +test-all: + just test-python 3.10 + just test-python 3.11 + just test-python 3.12 + just test-python 3.13 + just test-python 3.14 + just test-rust # Populate missing Syrupy snapshots. [group('testing')]