Breaking-API Changelog Pull Request Template (No Invented Versions)
Ppromptstudio·Aug 26, 2026
No rating
Write a GitHub PR body template for a breaking API change from a spec. No invented versions, sunset dates, or traffic stats.
Act as an API program manager writing a GitHub pull-request body for a breaking API change. You write a GitHub PR template and a filled example body from a breaking-change spec. You do not invent a version number, a sunset date, a traffic percentage, or a successor path. This is not a Keep a Changelog dump, not a customer deprecation email, and not a git log rewrite.
You work only from Inputs. Do not invent stats, citations, quotes, URLs, names, IDs, or records that are not in Inputs.
Inputs:
- Repo and default branch: [Repo]
- PR title I already want (or NONE): [Title]
- Pasted spec or design note for the break: [Spec]
- Endpoints, fields, or headers that break (quote Spec): [Breaks]
- Replacement I can prove (or NONE): [Replacement]
- Version bump I can prove (semver as already decided): [Version or NONE]
- Migration steps I can prove: [Steps]
- Checks that must stay green: [Checks]
- Reviewers or CODEOWNERS teams I may @ (or NONE): [Reviewers]
- Words I must not use: [Banned]
Generate:
1. Honesty ledger: repo, breaks, replacement, version, checks, reviewers. Forbidden: any version, sunset, or successor not in Inputs.
2. PR title (72 chars max). Reuse Title if given. Else build from Breaks only. Print the count. Do not put a version in the title unless Version is not NONE.
3. Template markdown: ## Summary, ## Breaking change, ## Replacement, ## Migration, ## Test plan, ## Rollback. Empty sections stay as HTML comments, not invented prose.
4. Filled example body using only Spec, Breaks, Replacement, Version, Steps, Checks.
5. Checklist: each Checks item as a box. If Checks is empty, write no CI names in Inputs.
6. Reviewer line: only Reviewers. If NONE, write no reviewers named.
7. What this PR is not: customer deprecation notice, Keep a Changelog file, git log. Say so in a footer.
8. Compliance pass: quote Banned words, invented versions, invented sunset dates. Cut them.
Constraints:
- GitHub PR body for a breaking API change. Not a customer deprecation notice and not Keep a Changelog.
- Never invent a version, sunset date, replacement path, or traffic share.
- If Version is NONE, write version not specified rather than bumping semver.
- Do not @ teams that are not in Reviewers.
- No emojis.