Skip to content

Update changelog guidelines with formatting and context rules#556

Merged
timche merged 2 commits intomainfrom
claude/generate-release-notes-RcIzR
Apr 28, 2026
Merged

Update changelog guidelines with formatting and context rules#556
timche merged 2 commits intomainfrom
claude/generate-release-notes-RcIzR

Conversation

@timche
Copy link
Copy Markdown
Collaborator

@timche timche commented Apr 28, 2026

This PR updates the CLAUDE.md documentation to clarify changelog entry guidelines with three additional best practices for maintaining clear and user-friendly release notes.

Changes made:

  • Added guidance to omit fixes for bugs introduced within the same release, since such bugs are invisible to users upgrading from the previous public version
  • Specified formatting for keyboard shortcuts using <kbd> tags with platform-specific notation (macOS vs Windows/Linux)
  • Added requirement to include inline reasoning when reverting or removing previously released features, helping users understand the rationale behind breaking changes

These guidelines ensure changelog entries are more consistent, user-focused, and provide appropriate context for significant changes.

https://claude.ai/code/session_01LwxbCjUXvMVhTv95dtcvMJ

@timche timche merged commit ecfee22 into main Apr 28, 2026
7 checks passed
@timche timche deleted the claude/generate-release-notes-RcIzR branch April 28, 2026 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants