Skip to content

chore: add tone calibration to release notes prompt #8010

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jdx merged 1 commit into from
Feb 5, 2026
Merged

chore: add tone calibration to release notes prompt #8010

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion xtasks/gen-release-notes
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,16 @@ TITLE GUIDELINES:
- Be creative and memorable (e.g., "The Great Backend Migration", "Conda Gets Cozy", "Monorepo Magic")
- Reference the main theme or biggest feature of the release
- Keep it fun but professional
- For smaller or less impactful releases, keep the title understated and modest

TONE CALIBRATION:
- Match the tone and length to the actual significance of the changes
- If the release is mostly small bug fixes or minor tweaks, be upfront about that—a sentence or two of summary is fine, don't write multiple paragraphs inflating the importance
- Reserve enthusiastic, detailed write-ups for releases with genuinely significant features or changes
Comment on lines +52 to +54

@gemini-code-assist gemini-code-assist Bot Feb 5, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The TONE CALIBRATION section can be structured more clearly for the LLM by using nested points. This groups the related instructions for minor and major releases under the main principle, which can lead to more consistent output from the language model.

- Match the tone and length to the actual significance of the changes:
  - For minor releases (e.g., mostly bug fixes), keep the summary brief (1-2 sentences) and do not inflate the importance.
  - For major releases with significant new features, a more enthusiastic and detailed summary is appropriate.

- It's okay to say "This is a smaller release focused on bug fixes" when that's the case

RELEASE NOTES:
1. Start with 1-2 paragraphs summarizing key changes
1. Start with a summary proportional to the significance of the changes
2. Organize into ### sections (Highlights, Bug Fixes, etc.)
3. Explain WHY changes matter to users
4. Include PR links and documentation links (https://mise.jdx.dev/)
Expand Down
Loading