Skip to content

Development#

Notes for developers. If you want to get involved, please do!

Language#

We use British English for our development. We do this for consistency with the broader work context of our lead developers.

Versioning#

This package follows the version format described in PEP440 and Semantic Versioning to describe how the version should change depending on the updates to the code base.

Releasing#

Releasing is semi-automated via a CI job. The CI job requires the type of version bump that will be performed to be manually specified. See the uv version docs (specifically the --bump flag) for the list of available bump rules.

Standard process#

The steps required are the following:

  1. Bump the version: manually trigger the "bump" stage from the latest commit in main (pipelines are here). A valid "bump_rule" (see uv's docs) will need to be specified via the 'bump-rule' CI input (see https://docs.gitlab.com/ci/inputs). This will then trigger a release.

  2. Update projects to use the new copier version

Read the Docs#

Our documentation is hosted by Read the Docs (RtD), a service for which we are very grateful. ProperDocs configuration is in properdocs.yml, and the RtD configuration can be found in the .readthedocs.yaml file in the root of this repository. The docs are automatically deployed at copier-basic-python-repository.readthedocs.io.