Skip to content

Commit e0115e6

Browse files
committed
Update GitHub release notes template with best practices
Standardize release note documentation with clear, consistent formatting guidelines. This helps maintainers create more informative and readable release communications. - Add recommended sections: Added, Changed, Fixed - Specify preferred section order and headers - Include guidance on summary and section handling - Use markdown h2 headers for sections
1 parent 6ddf911 commit e0115e6

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,26 @@ just dmg # Create DMG installer
5050
gh release create v0.0.X # Create GitHub release with assets
5151
```
5252

53+
### GitHub Release Notes Format
54+
55+
```
56+
One paragraph summary of the release.
57+
58+
## Added
59+
- New features
60+
61+
## Changed
62+
- Changes to existing functionality
63+
64+
## Fixed
65+
- Bug fixes
66+
```
67+
68+
- Summary paragraph first (no header)
69+
- Sections use `##` (h2) headers
70+
- Section order: Added → Changed → Fixed
71+
- Omit empty sections
72+
5373
### App Store
5474

5575
```bash

0 commit comments

Comments
 (0)