Skip to content

docs: document PR template and checklist bot in AGENTS.md #1585

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AngeloDanducci merged 1 commit into from
Aug 26, 2026
Merged

docs: document PR template and checklist bot in AGENTS.md #1585

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,17 @@ mkdir -p .bob && ln -s ../.agents/skills .bob/skills

Pre-commit runs: ruff, mypy, uv-lock, codespell, license-headers

**Pull request template**: opening a PR fills the body from [`.github/pull_request_template.md`](.github/pull_request_template.md), which ends with four type checkboxes - `Component`, `Requirement`, `Sampling Strategy`, `Tool`. If your PR adds or modifies one of those, check the matching box; the `PR Bot` workflow ([`.github/workflows/pr-update.yml`](.github/workflows/pr-update.yml)) then posts a comment with the type-specific review checklist from `.github/PULL_REQUEST_TEMPLATE/`:

| Checked box | Checklist template |
|-------------|--------------------|
| `Component` | `.github/PULL_REQUEST_TEMPLATE/component.md` |
| `Requirement` | `.github/PULL_REQUEST_TEMPLATE/requirement.md` |
| `Sampling Strategy` | `.github/PULL_REQUEST_TEMPLATE/sampling.md` |
| `Tool` | `.github/PULL_REQUEST_TEMPLATE/tool.md` |

This matters when a PR is opened outside the GitHub UI (`gh pr create --body`, from a fork, or by an agent): the template isn't applied automatically. When you open such a PR and it adds or modifies one of the four types, build the body from `.github/pull_request_template.md` with the matching box checked (if relevant) so the bot posts the checklist.

**Review states**: when reviewing a PR, see [CONTRIBUTING.md → Review States](CONTRIBUTING.md#review-states) for when to use `APPROVE` vs `REQUEST CHANGES` vs `COMMENT`.

For AI attribution trailers, see [Section 7 (AI Attribution)](#7-ai-attribution).
Expand Down
Loading