You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,13 +22,17 @@ Follow these instructions in addition to any higher-level system or tool rules.
22
22
-**Preserve public behavior and CLI UX** — no breaking changes to APIs, CLI flags, or exit codes unless explicitly requested.
23
23
-**Update or add tests/docs** when you change user-facing behavior.
24
24
-**Commit messages** must follow [Conventional Commits](https://www.conventionalcommits.org/) (enforced by commitizen itself).
25
+
-**Pull requests** must follow the [Pull Request Guidelines](docs/contributing/pull_request.md) and the template in `.github/pull_request_template.md`.
25
26
26
27
## Setup and Validation
27
28
29
+
> Full contributor guidelines (prerequisites, workflow, PR process): [`docs/contributing/contributing.md`](docs/contributing/contributing.md).
30
+
28
31
### Bootstrap
29
32
30
33
```bash
31
34
uv sync --frozen --group base --group test --group linters
35
+
uv run poe setup-pre-commit # install git hooks (uses prek, a pre-commit runner)
32
36
```
33
37
34
38
### Local commands
@@ -44,7 +48,7 @@ Always run at least `uv run ruff check --fix . && uv run ruff format .` before p
44
48
### CI pipeline
45
49
46
50
- CI runs `poe ci` on a matrix of Python 3.10–3.14 × ubuntu/macos/windows.
47
-
- Pre-commit hooks are defined in `.pre-commit-config.yaml` and run via `prek`.
51
+
- Pre-commit hooks are defined in `.pre-commit-config.yaml` and run via [`prek`](https://github.com/j178/prek) (a `pre-commit` compatible runner).
48
52
- The matrix is **fail-fast**: inspect the earliest failing job that completed; others are cancelled.
0 commit comments