Skip to content

Commit b5dfda6

Browse files
chore: sync AGENTS rules to keep contributor guidance consistent (#8)
1 parent c0baf62 commit b5dfda6

2 files changed

Lines changed: 18 additions & 1 deletion

File tree

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@ include/
5151
pyvenv.cfg
5252

5353
.tox
54-
.worktrees
5554
pip-wheel-metadata
5655

5756

@@ -61,3 +60,4 @@ test_capi
6160
test_capi
6261
/mypyc/lib-rt/build/
6362
/mypyc/lib-rt/*.so
63+
.worktrees/

AGENTS.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
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) Keep base image tags pinned.
16+
17+
Reference: https://www.conventionalcommits.org/en/v1.0.0/

0 commit comments

Comments
 (0)