Documentation
¶
Overview ¶
Command checkpr holds a pull request description to the template (the job `Pull request description` in ci.yml, part of `CI required`; `make gate-pr BODY=<file>` locally).
A description is where the use cases' checks and the premises found false are recorded, and the template is how AGENTS.md asks for them. It was skipped anyway, by a session that wrote descriptions from scratch with `gh pr create --body`: GitHub shows the template only to somebody who opens the form. This reads the description the way a reviewer would and names what is missing.
Usage: checkpr -body <file> [-title <title>] [-opened <RFC 3339>] [-base <ref> [-head <ref>]] (or the description on stdin). The title is a Conventional Commit (title.go). With -base it also reads the branch's history: merged migrations it changes, use cases it deletes, settled ADRs it rewrites, section numbers of subject documents it drops (rules.go). A rule added after a pull request was opened (-opened) does not apply to it.
Source Files