From: Tamir Duberstein <tamird@kernel.org>
To: "Kernel.org Tools" <tools@kernel.org>
Cc: Konstantin Ryabitsev <konstantin@linuxfoundation.org>,
Tamir Duberstein <tamird@kernel.org>
Subject: [PATCH ezgb v2 3/3] Document local CI checks
Date: Fri, 18 Sep 2026 18:03:23 -0400 [thread overview]
Message-ID: <20260918-stronger-type-checking-v2-3-3ddc31ba2616@kernel.org> (raw)
In-Reply-To: <20260918-stronger-type-checking-v2-0-3ddc31ba2616@kernel.org>
Development dependencies are now a dependency group, so the documented
.[dev] extra no longer installs them. Document uv sync and ci.sh in the
README and contributor guide so local checks include all linters, type
checkers and tests.
Signed-off-by: Tamir Duberstein <tamird@kernel.org>
Assisted-by: LLM
---
CONTRIBUTING.md | 15 ++++++++-------
README.md | 13 +++++++------
2 files changed, 15 insertions(+), 13 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ac70676..0a6a0b7 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -28,16 +28,17 @@ contributor guide has a good overview:
- Python 3.10+, `from __future__ import annotations` in every module.
- `%`-style string formatting to match the existing code.
-- Run `ruff check` and `mypy --strict` before submitting.
+- Run `./ci.sh` before submitting.
-## Running tests
+## Development checks
- pip install -e '.[dev]'
- python -m pytest
+ uv sync --all-groups
+ ./ci.sh
-The test suite includes unit tests (using real git objects in temporary
-repos via pygit2) and integration tests that exercise the full stack
-including the `git-bug` binary.
+The CI script runs Ruff, ty, mypy, pyright, and pytest. The test suite
+includes unit tests (using real git objects in temporary repos via
+pygit2) and integration tests that exercise the full stack including the
+`git-bug` binary.
## Licensing
diff --git a/README.md b/README.md
index 3ee811e..4d9042d 100644
--- a/README.md
+++ b/README.md
@@ -59,16 +59,17 @@ make -C docs html
Then open `docs/_build/html/index.html` in your browser.
-## Running tests
+## Development checks
```bash
-pip install -e '.[dev]'
-python -m pytest
+uv sync --all-groups
+./ci.sh
```
-The test suite includes unit tests (using real git objects in temporary
-repos via pygit2) and integration tests that exercise the full stack
-including the `git-bug` binary.
+The CI script runs Ruff, ty, mypy, pyright, and pytest. The test suite
+includes unit tests (using real git objects in temporary repos via
+pygit2) and integration tests that exercise the full stack including the
+`git-bug` binary.
## Contributing
--
2.56.0.rc0.692.g34fd115c35.frankengit
next prev parent reply other threads:[~2026-09-18 22:03 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-18 22:03 [PATCH ezgb v2 0/3] Tighten JSON and source type checks Tamir Duberstein
2026-09-18 22:03 ` [PATCH ezgb v2 1/3] Narrow JSON types and type test doubles Tamir Duberstein
2026-09-18 22:03 ` [PATCH ezgb v2 2/3] Enable strict pyright source checks Tamir Duberstein
2026-09-18 22:03 ` Tamir Duberstein [this message]
2026-10-05 10:57 ` [PATCH ezgb v2 0/3] Tighten JSON and source type checks Konstantin Ryabitsev
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260918-stronger-type-checking-v2-3-3ddc31ba2616@kernel.org \
--to=tamird@kernel.org \
--cc=konstantin@linuxfoundation.org \
--cc=tools@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox