Skip to content

Commit b7792b2

Browse files
committed
chore: update agent requirements to keep contributor workflow consistent
1 parent 36e29de commit b7792b2

2 files changed

Lines changed: 21 additions & 0 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,4 @@ test_capi
6060
test_capi
6161
/mypyc/lib-rt/build/
6262
/mypyc/lib-rt/*.so
63+
.worktrees/

AGENTS.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Agent Requirements
2+
3+
All agents must follow these rules:
4+
5+
1) Fully test your changes before submitting a PR (run the full suite or all relevant tests).
6+
2) PR titles must be descriptive and follow Conventional Commits-style prefixes:
7+
- Common: `feat:`, `fix:`, `chore:`, `refactor:`, `docs:`, `test:`, `perf:`
8+
- Support titles: `fix(docs):`, `fix(benchmarks):`, `fix(cicd):`
9+
3) Commit messages must follow the same Conventional Commits-style prefixes and include a short functional description plus a user-facing value proposition.
10+
4) PR descriptions must include `Summary`, `Rationale`, and `Details` sections.
11+
5) Run relevant Python tests for changes (pytest/unittest or the repo's configured runner).
12+
6) Follow formatting/linting configured in pyproject.toml, setup.cfg, tox.ini, or ruff.toml.
13+
7) Update dependency lockfiles when adding or removing Python dependencies.
14+
8) If the repo uses mypyc, verify tests run against compiled extensions (not interpreted Python) and note how you confirmed.
15+
9) All mypy configuration (flags, overrides, per-module ignores, and file targets) should go in pyproject.toml. Do not split config across CLI args, mypy.ini, setup.cfg, or workflow steps.
16+
10) Centralize pytest settings (flags, markers, ignore patterns, and targets) in pyproject.toml, pytest.ini, setup.cfg, or tox.ini; workflows/hooks should call pytest without inline args.
17+
11) For unittest workflows, prefer python -m unittest without inline args; if discovery arguments are required, centralize them in a single script and call that from CI.
18+
12) Keep base image tags pinned.
19+
20+
Reference: https://www.conventionalcommits.org/en/v1.0.0/

0 commit comments

Comments
 (0)