Skip to content

Commit a4a0ab0

Browse files
justin808claude
andcommitted
Add changelog guidelines to CLAUDE.md
Following the Shakapacker PR #742 guidelines, this adds comprehensive changelog documentation requirements to CLAUDE.md: - Changelog entries required for user-visible changes only (features, bug fixes, breaking changes, deprecations, performance improvements) - No entries needed for linting, formatting, internal refactoring, tests, or documentation fixes - Format requirements: PR links, author links, consistent formatting - Breaking changes: bold formatting with migration guide links - Version release: update version diff links This ensures consistent, high-quality changelog maintenance across the project. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 2b5bab8 commit a4a0ab0

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

CLAUDE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,19 @@ Git hooks will automatically run linting on **all changed files (staged + unstag
4141
- **⚠️ MANDATORY BEFORE GIT PUSH**: `bundle exec rubocop` and fix ALL violations + ensure trailing newlines
4242
- Never run `npm` commands, only equivalent Yarn Classic ones
4343

44+
## Changelog
45+
46+
- **Update CHANGELOG.md for user-visible changes only**
47+
- User-visible changes include: new features, bug fixes, breaking changes, deprecations, performance improvements
48+
- **Do NOT add changelog entries for**: linting fixes, code formatting, internal refactoring, test updates, documentation fixes
49+
- Non-user-visible changes don't need changelog entries even if they modify code
50+
- **Format requirements**:
51+
- Always link to the PR: `[PR #123](https://github.com/shakacode/react_on_rails/pull/123)`
52+
- Always link to the author: `by [username](https://github.com/username)`
53+
- Keep formatting consistent with existing entries
54+
- When releasing a version, update the version diff links at the bottom of CHANGELOG.md
55+
- **For breaking changes**: Use bold formatting and link to migration documentation (e.g., `**Breaking**: Description. See [Migration Guide](docs/vX_upgrade.md)`)
56+
4457
## ⚠️ FORMATTING RULES
4558

4659
**Prettier is the SOLE authority for formatting non-Ruby files, and RuboCop for formatting Ruby files. NEVER manually format code.**

0 commit comments

Comments
 (0)