📌 Description
The repository maintains a CHANGELOG.md, but there's no PR template nudging contributors to add an entry, so it's easy for a merged feature/fix to go undocumented in the changelog over time as the project's contributor base grows via bounty-style external contributions.
🧩 Requirements and context
- Add (or extend, if one already exists) a
.github/pull_request_template.md with a checklist item reminding contributors to add a CHANGELOG.md entry for user-facing changes.
- Briefly document the expected
CHANGELOG.md entry format/section (e.g. Added/Changed/Fixed) in the template or in CHANGELOG.md's own header, based on its current structure.
- Keep the template lightweight — this should not add unnecessary friction for trivial changes (docs-only, test-only).
🛠️ Suggested execution
- Add or update
.github/pull_request_template.md with the changelog checklist item.
- Cross-check
CHANGELOG.md's existing structure/conventions and reference them briefly in the template.
✅ Acceptance criteria
🔒 Security notes
No new attack surface; a process/documentation task.
📋 Guidelines
- Minimum 95% test coverage
- Clear documentation
- Timeframe: 96 hours
📌 Description
The repository maintains a
CHANGELOG.md, but there's no PR template nudging contributors to add an entry, so it's easy for a merged feature/fix to go undocumented in the changelog over time as the project's contributor base grows via bounty-style external contributions.🧩 Requirements and context
.github/pull_request_template.mdwith a checklist item reminding contributors to add aCHANGELOG.mdentry for user-facing changes.CHANGELOG.mdentry format/section (e.g. Added/Changed/Fixed) in the template or inCHANGELOG.md's own header, based on its current structure.🛠️ Suggested execution
.github/pull_request_template.mdwith the changelog checklist item.CHANGELOG.md's existing structure/conventions and reference them briefly in the template.✅ Acceptance criteria
🔒 Security notes
No new attack surface; a process/documentation task.
📋 Guidelines