prepare-release-notes

Prepare Release Notes

Polish pending React Router change files and add manual release notes only when the release needs narrative context beyond the generated change lists.

Workflow

1. Inspect local state:

git status --short
find packages -path '*/.changes/*.md' -not -name README.md -not -name .gitkeep -print | sort

1. Read every pending change file. Do not edit generated changelogs or released notes directly.

2. Normalize each change file:

   • Remove feat:, feat(...), fix:, and fix(...) semantic-commit prefixes from prose
   • Use present or imperative tense for the first line and top-level release bullets: prefer Add, Fix, Remove, Support, Stabilize, Preserve, Update, Avoid, Prevent, Throw, Warn, Expose
   • Nested detail bullets can stay explanatory when they expand on the parent bullet; do not rewrite them solely to force present or imperative tense
   • Remove terminal sentence periods from bullet items because release generation appends PR/commit links after the first bullet line
   • Remove terminal sentence periods from nested bullet items too, unless the punctuation is part of code, a URL, an abbreviation, a version number, or another token where removing it would be wrong
   • If one bullet contains multiple sentences, split it into a shorter parent bullet plus nested bullet items
   • Keep the first line concise and user-facing; use nested bullets for details or migration notes

3. Review whether scripts/changes/whats-changed.md is needed:

   • Read CHANGELOG.md examples or references/whats-changed.md when uncertain
   • Add scripts/changes/whats-changed.md only for features, future flag stabilizations, unstable flags, migration guidance, breaking bug fixes, or complex behavior that needs long-form text or examples
   • Do not add it for ordinary bug fixes, dependency cleanup, internal refactors, or release bullets that are already clear
   • If adding it, write the body only; the release script adds ### What's Changed when missing