jedarden/miroir
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
miroir/.github/pull_request_template.md
jedarden 1d4bba0642 docs(pr): improve PR templates for CHANGELOG discipline 
- Update main PR template to emphasize CHANGELOG entries for every behavior change
- Add clear example of how to format CHANGELOG entries
- Create separate release_pr_template.md with comprehensive release checklist
- Move release checklist to bottom of main template with reference to separate template

The templates now institutionalize the plan §7 CHANGELOG pattern:
- Regular PRs: add entry under [Unreleased] with clear format guidance
- Release PRs: use dedicated template with full checklist matching plan §7

Closes: miroir-uyx.2
2026-05-24 21:00:14 -04:00

1.5 KiB
Raw Permalink Blame History

What changed

Why

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (internal restructuring, no external behavior change)
  • Documentation
  • Release

CHANGELOG entry

Breaking changes

Test plan

Release checklist (only for release PRs)

If this is a release PR, use .github/release_pr_template.md instead and verify:

  • All tests pass on main (cargo test --workspace)
  • CHANGELOG.md updated with new version section (## [x.y.z] - YYYY-MM-DD)
  • Cargo.toml workspace version bumped (scripts/bump-version.sh x.y.z)
  • Chart.yaml version and appVersion updated (done by bump script)
  • scripts/release-ready-check.sh passes locally
  • Migration notes written in CHANGELOG.md if task store schema changed