Skip to content

Commit 0f60179

Browse files
timsaucerclaude
andcommitted
Add PR template and pre-commit check guidance to AGENTS.md
Document that all PRs must follow .github/pull_request_template.md and that pre-commit hooks must pass before committing. List all configured hooks (actionlint, ruff, ruff-format, cargo fmt, cargo clippy, codespell, uv-lock) and the command to run them manually. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 11bb9b3 commit 0f60179

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,41 @@ Skills follow the [Agent Skills](https://agentskills.io) open standard. Each ski
3333
- `SKILL.md` — The skill definition with YAML frontmatter (name, description, argument-hint) and detailed instructions.
3434
- Additional supporting files as needed.
3535

36+
## Pull Requests
37+
38+
Every pull request must follow the template in
39+
`.github/pull_request_template.md`. The description must include these sections:
40+
41+
1. **Which issue does this PR close?** — Link the issue with `Closes #NNN`.
42+
2. **Rationale for this change** — Why the change is needed (skip if the issue
43+
already explains it clearly).
44+
3. **What changes are included in this PR?** — Summarize the individual changes.
45+
4. **Are there any user-facing changes?** — Note any changes visible to users
46+
(new APIs, changed behavior, new files shipped in the package, etc.). If
47+
there are breaking changes to public APIs, add the `api change` label.
48+
49+
## Pre-commit Checks
50+
51+
Always run pre-commit checks **before** committing. The hooks are defined in
52+
`.pre-commit-config.yaml` and include:
53+
54+
- **actionlint** — lint GitHub Actions workflow files
55+
- **ruff** — Python linter
56+
- **ruff-format** — Python formatter
57+
- **cargo fmt** — Rust formatter (nightly)
58+
- **cargo clippy** — Rust linter
59+
- **codespell** — spell checker
60+
- **uv-lock** — keep the uv lockfile in sync
61+
62+
Run all hooks with:
63+
64+
```bash
65+
pre-commit run --all-files
66+
```
67+
68+
Or they will run automatically on `git commit` if pre-commit is installed as a
69+
git hook. Fix any failures before committing.
70+
3671
## Python Function Docstrings
3772

3873
Every Python function must include a docstring with usage examples.

0 commit comments

Comments
 (0)