Story: Standardize the compass pr create body template with a Testing section
Table of Contents
This page documents a story in Sprint 25. It captures the goal, current status, acceptance criteria, and the tasks that compose it.
1. Goal
compass pr create assembles the PR body from --summary and
--change bullets only. Verification detail folds into the Changes
bullets as an afterthought, so every raise must be told to include it:
PR #2021 again carried no Testing section, and the hand retrofit that
added one to PR #2020 overwrote the body wholesale and lost its
Traceability table. This story makes the generator carry the whole
template. Every compass pr create raise emits Summary, Changes,
Traceability, and a mandatory Testing section (Plan, Evidence,
Limitations) taken from the required
--testing-plan=/–testing-evidence=/=–testing-limitations= flags,
followed by the footer. The compass-pr-raise skill, the create-a-PR recipe and
the developer.org PR spec document the fixed template; compass tests
pin its shape; and the story's own PR is raised with the template it
ships.
2. Status
| Field | Value |
|---|---|
| State | DONE |
| Parent sprint | Sprint 25 |
| Now | Nothing. |
| Waiting on | Nothing. |
| Next | Nothing. |
| Last touched | 2026-09-06 |
3. Acceptance
compass pr createrequires--testing-plan,--testing-evidenceand--testing-limitations, and emits the Testing section with Plan, Evidence and Limitations paragraphs after the Traceability table and before the footer.- Compass tests pin the fixed body shape: section order, flag validation, and Traceability derivation are covered.
- The compass-pr-raise skill, the how-do-I-create-a-PR recipe and developer.org describe the fixed template, and the skills bundle is rebuilt.
- The story's own PR is raised with the new template.
- PR #2021's body is retrofitted to the fixed template with its Traceability table intact.
4. Tasks
| Task | State | Start | End | Description |
|---|---|---|---|---|
| Implement the fixed PR body template with a Testing section in compass pr create | DONE | 2026-09-06 | 2026-09-06 | Add required –testing-plan/–testing-evidence/–testing-limitations flags to compass pr create behind a canonical body template (Summary / Changes / Traceability / Testing + footer); update the compass tests; update the compass-pr-raise skill, the create-a-PR recipe and the developer.org PR spec to the fixed template; raise this PR using the new template itself. |
5. Decisions
- The PR body template is fixed at the generator: Summary / Changes /
Traceability / Testing, then the footer. The Testing section comes
from required
--testing-plan,--testing-evidenceand--testing-limitationsflags; a raise is refused before any push, naming every flag with no text at once. - Verification belongs in the Testing section's Evidence paragraph
(change class; checks run and results), not in a
--changebullet. - A body retrofit rebuilds the full canonical body and applies it with
gh pr edit --body-file, so the Traceability table survives — never a wholesale overwrite that drops it.
6. Out of scope
- Back-filling Testing sections onto older PRs (#2014 and earlier).
- Enforcing the template on hand-written
gh pr createcalls outsidecompass pr create(documented only).