Noticed while reviewing #177.
Problem
AGENTS.md:139-141 requires user-facing changes to be added to CHANGELOG.md under the [Unreleased] heading, and docs/RELEASING.md cuts release notes from that section — so a missing entry silently drops the change from the next release notes.
But neither CONTRIBUTING.md nor .github/PULL_REQUEST_TEMPLATE.md mentions the CHANGELOG at all. The PR template only has Summary / Changes / Testing / Screenshots. An outside contributor has no way to learn the rule from the contributor-facing docs, so we end up asking for it in review after the fact.
Suggested fix
- Add a CHANGELOG section to
CONTRIBUTING.md describing the [Unreleased] convention and the Keep a Changelog subsections (Added / Changed / Fixed), including the "don't invent or cut a version" rule.
- Add a checklist item to
.github/PULL_REQUEST_TEMPLATE.md, e.g. - [ ] Added a CHANGELOG.md entry under [Unreleased] (user-facing changes only).
- Link an example entry so the house style (bold lead clause, em dash, old-behavior-then-new-behavior prose) is discoverable.
Noticed while reviewing #177.
Problem
AGENTS.md:139-141requires user-facing changes to be added toCHANGELOG.mdunder the[Unreleased]heading, anddocs/RELEASING.mdcuts release notes from that section — so a missing entry silently drops the change from the next release notes.But neither
CONTRIBUTING.mdnor.github/PULL_REQUEST_TEMPLATE.mdmentions the CHANGELOG at all. The PR template only has Summary / Changes / Testing / Screenshots. An outside contributor has no way to learn the rule from the contributor-facing docs, so we end up asking for it in review after the fact.Suggested fix
CONTRIBUTING.mddescribing the[Unreleased]convention and the Keep a Changelog subsections (Added/Changed/Fixed), including the "don't invent or cut a version" rule..github/PULL_REQUEST_TEMPLATE.md, e.g.- [ ] Added a CHANGELOG.md entry under [Unreleased] (user-facing changes only).