Skip to content

Commit dcbde0b

Browse files
committed
Doc: release process
Document release process. Closes #21.
1 parent 5403f10 commit dcbde0b

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

doc/contributing.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,20 @@ To set up the pre-commit hooks in your local environment, follow these steps:
3535

3636
3. You're all set! The pre-commit hooks will now run automatically before each
3737
commit.
38+
39+
40+
Release Process
41+
---------------
42+
43+
To ensure a smooth release process, we follow these steps:
44+
45+
1. Update the release notes in ``doc/CHANGELOG.rst`` with the latest changes
46+
and version number.
47+
48+
2. Create a `new release <https://github.com/ICB-DCM/C-COMPASS/releases/new>`__
49+
via GitHub, following the Python versioning specifier scheme
50+
for the tag name (e.g., ``v1.0.0``). (For more information, see the
51+
`PyPA guide <https://packaging.python.org/en/latest/specifications/version-specifiers/#version-specifiers>`__.)
52+
53+
3. The release will be automatically built and published to PyPI and Zenodo
54+
by GitHub Actions.

0 commit comments

Comments
 (0)