Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 23 additions & 9 deletions doc/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Release process

.. code-block:: shell

towncrier build --version X.Y.Z
uv run towncrier build --version X.Y.Z

This adds a new section for the release to ``CHANGELOG.md``, and removes
the collected fragments (``git rm``). Run with ``--draft`` to only preview
Expand All @@ -52,8 +52,7 @@ Release process
For a new minor version, add a ``## X.Y series`` heading and move the
``<!-- towncrier release notes start -->`` marker below it.

3. Create a pull request with the to-be-released changes to the main branch
(usually from ``develop``).
3. Create a pull request with these changes to ``main``.

4. Once the pull request is merged, create a new release on GitHub.
Make sure to set the tag to the version number prefixed with 'v'
Expand All @@ -64,27 +63,42 @@ Release process
The upload to PyPI is performed automatically by a GitHub Actions workflow,
which may take a few minutes to complete.

6. Merge the main branch back into the `develop` branch.
Testing
-------

To run the unit tests, run:

.. code-block:: bash

uv run pytest tests

Tests for the BNGL import are skipped unless the respective test models
have been downloaded via:

.. code-block:: bash

uv run --no-project python -P tests/v1/fetch_bngl_corpus.py

Style guide
-----------

Code style
~~~~~~~~~~

We use pre-commit with ruff to enforce code style. To install pre-commit and
the pre-commit hooks, run:
We use pre-commit with ruff to enforce code style.
pre-commit is part of the default ``dev`` dependency group.
To install it and the pre-commit hooks, run:

.. code-block:: bash

uv tool install pre-commit
pre-commit install
uv sync
uv run pre-commit install

To run the pre-commit checks manually on all, not just the modified files, run:

.. code-block:: bash

pre-commit run --all-files
uv run pre-commit run --all-files

Documentation style
~~~~~~~~~~~~~~~~~~~
Expand Down
Loading