Release Notes
Turn implementation details into user-facing release notes.
Process
- Identify the user-facing outcome.
- Group related implementation details into one bullet.
- Avoid internal file names unless the user asks for engineering notes.
- Keep the tone factual and concise.
When the user provides a rough list of changes, run
scripts/format-release-notes.ts with { "changes": [...] } to create a first
draft, then polish the wording for the user's audience. The TypeScript script
is function-style (export default run(input, ctx)) and demonstrates reading
references/style-guide.md from ctx.files.
Output format
Use this structure:
## Summary
- One to three bullets describing what changed.
## Notes
- Optional caveats, migration details, or follow-up work.If the input is too vague, ask for the target audience and the release scope.