Skip to content

Commit 4976c1c

Browse files
committed
chore: update agent requirements and .gitignore to keep contributor guidance current
1 parent b7792b2 commit 4976c1c

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

AGENTS.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,15 @@ All agents must follow these rules:
77
- Common: `feat:`, `fix:`, `chore:`, `refactor:`, `docs:`, `test:`, `perf:`
88
- Support titles: `fix(docs):`, `fix(benchmarks):`, `fix(cicd):`
99
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.
10+
4) PR descriptions must include Summary, Rationale, and Details sections.
1111
5) Run relevant Python tests for changes (pytest/unittest or the repo's configured runner).
1212
6) Follow formatting/linting configured in pyproject.toml, setup.cfg, tox.ini, or ruff.toml.
1313
7) Update dependency lockfiles when adding or removing Python dependencies.
1414
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.
15+
9) Maximize the use of caching in GitHub workflow files to minimize run duration.
16+
10) Use one of `paths` or `paths-ignore` in every workflow file to make sure workflows only run when required.
17+
11) 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.
18+
12) 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.
19+
13) Keep base image tags pinned.
1920

2021
Reference: https://www.conventionalcommits.org/en/v1.0.0/

0 commit comments

Comments
 (0)