Skip to content

Commit b0da6f5

Browse files
dbdimitrovclaude
andcommitted
docs: update contributing guide for mypy, build CI, and bumpversion
- Add mypy type-checking note in Code-style section - Document the new build.yaml CI workflow (uv build + twine check) - Fix bump2version → bumpversion (aligns with pyproject.toml dev dep) - Update README CI badge URL: main.yml → test.yml (workflow rename) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent e2b49dc commit b0da6f5

2 files changed

Lines changed: 16 additions & 5 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# LIANA+: an all-in-one cell-cell communication framework <img src="https://raw.githubusercontent.com/saezlab/liana-py/main/docs/_static/logo.png" align="right" height="125">
22

33
<!-- badges: start -->
4-
[![main](https://github.com/saezlab/liana-py/actions/workflows/main.yml/badge.svg)](https://github.com/saezlab/liana-py/actions)
4+
[![main](https://github.com/saezlab/liana-py/actions/workflows/test.yml/badge.svg)](https://github.com/saezlab/liana-py/actions)
55
[![GitHub issues](https://img.shields.io/github/issues/saezlab/liana-py.svg)](https://github.com/saezlab/liana-py/issues/)
66
[![Documentation Status](https://readthedocs.org/projects/liana-py/badge/?version=latest)](https://liana-py.readthedocs.io/en/latest/?badge=latest)
77
[![codecov](https://codecov.io/gh/saezlab/liana-py/branch/main/graph/badge.svg?token=TM0P29KKN5)](https://codecov.io/gh/saezlab/liana-py)

docs/contributing.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,14 @@ git pull --rebase
6666
to integrate the changes into yours.
6767
While the [pre-commit.ci][] is useful, we strongly encourage installing and running pre-commit locally first to understand its usage.
6868

69+
Type checking is enforced via [mypy][] (configured in `.pre-commit-config.yaml` with `--no-strict-optional --ignore-missing-imports`).
70+
No extra setup is needed — it runs automatically with `pre-commit`.
71+
6972
Finally, most editors have an _autoformat on save_ feature.
7073
Consider enabling this option for [ruff][ruff-editors] and [biome][biome-editors].
7174

7275
[pre-commit]: https://pre-commit.com/
76+
[mypy]: https://mypy.readthedocs.io/en/stable/
7377
[pre-commit.ci]: https://pre-commit.ci/
7478
[ruff-editors]: https://docs.astral.sh/ruff/integrations/
7579
[biome-editors]: https://biomejs.dev/guides/integrate-in-editor/
@@ -125,6 +129,9 @@ Additionally, there's a CI job that tests against pre-releases of all dependenci
125129
The purpose of this check is to detect incompatibilities of new package versions early on and
126130
gives you time to fix the issue or reach out to the developers of the dependency before the package is released to a wider audience.
127131

132+
A second CI job (`build.yaml`) runs on every push and pull request: it builds the package with `uv build` and validates it with `twine check --strict`.
133+
This catches packaging problems (missing metadata, broken wheels) before release.
134+
128135
## Publishing a release
129136

130137
### Updating the version number
@@ -145,11 +152,15 @@ Specify `vX.X.X` as a tag name and create a release.
145152
For more information, see [managing GitHub releases][].
146153
This will automatically create a git tag and trigger a Github workflow that creates a release on [PyPI][].
147154

148-
We also use bump2version to automatically update the version number in all places and automatically create a git tag. Run one of the following commands in the root of the repository
155+
We also use [bumpversion][] to automatically update the version number in all places and automatically create a git tag. Run one of the following commands in the root of the repository
156+
157+
```bash
158+
bumpversion patch
159+
bumpversion minor
160+
bumpversion major
161+
```
149162

150-
bump2version patch
151-
bump2version minor
152-
bump2version major
163+
[bumpversion]: https://github.com/peritus/bumpversion
153164

154165

155166
[semver]: https://semver.org/

0 commit comments

Comments
 (0)