-
Notifications
You must be signed in to change notification settings - Fork 2
Update guidelines for release notes and changelogs #90
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -113,15 +113,17 @@ This script automatically: | |
| **Mandatory Guidelines:** | ||
|
|
||
| ##### For Minor Releases: | ||
| - ✅ MUST contain a summary of ALL patch version release notes since last minor | ||
| - ✅ MUST contain a summary of ALL changelog items from ALL patch version bumps since last minor, including merges without a release | ||
| - ❌ Do NOT copy/paste the changelog entries verbatim | ||
| - ✅ Review and create human-friendly summarized content | ||
| - ⚠️ Avoid conflicts: If v0.5.4 solves an issue introduced in v0.5.2, consolidate appropriately (don't mention both) | ||
| - ⚠️ Avoid conflicts: If v0.5.4 solves an issue introduced in v0.5.2, consolidate appropriately (don't mention both) | ||
| - 📊 Group related changes into themes/categories | ||
| - 🎯 Focus on user impact, not technical implementation details | ||
|
|
||
| ##### For Major Releases: | ||
| - ✅ MUST contain a summary of ALL minor release notes since last major | ||
| - ✅ MUST contain a summary of ALL minor/patch release notes since last major | ||
| - ✅ MUST contain a summary of ALL changelog items of minor/patch version bumps, also for merges without a release | ||
|
Comment on lines
+125
to
+126
|
||
| - ❌ Do NOT copy/paste the changelog entries verbatim | ||
| - ✅ Review and create human-friendly summarized content | ||
| - ⚠️ Consolidate related changes across minors into coherent themes | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is an inconsistency within the same file. Line 109 documents that the script extracts "For major releases: includes all minor releases since last major" (no mention of patches), but the new guideline on line 125 states major releases must contain "ALL minor/patch release notes". The script documentation on line 109 should also be updated to mention patch releases if that's the intended behavior, or the guideline on line 125 should be corrected to match the actual script behavior.