Skip to content

fix: clarify usage of H3 headers in changelog section structure #218

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
merged 1 commit into from
Jun 2, 2025
Merged

fix: clarify usage of H3 headers in changelog section structure #218

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
2 changes: 1 addition & 1 deletion .github/scripts/changelog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Content Priority (High to Low):
6. Build/CI changes - generally omit unless they affect end users

Section Structure:
Use H3 headers only when you have substantial content. Organize logically under these sections:
Always use H3 headers (###) for the section titles below, but only include a section if it contains relevant entries. Do not render empty sections. Organize logically under these categories:
- 🚨 Breaking Changes (always first if present)
- ✨ New Features
- 🐛 Bug Fixes
Expand Down