Skip to content

Commit 4bac8ed

Browse files
justin808claude
andcommitted
Fix changelog guidelines: PR format and automation reference
Fixes identified in code review: 1. PR link format: Changed from `[PR #123]` to `[PR 1818]` (no hash) - Analysis shows 165 entries without hash vs only 7 with hash - Aligns with actual project standard 2. Added reference to `bundle exec rake update_changelog` - This is the existing automation for updating version headers - Mentioned in CHANGELOG.md line 18 but was missing from guidelines 3. Verified file ends with newline (required per CLAUDE.md) These changes ensure guidelines match actual usage and reference existing automation tools. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent a4a0ab0 commit 4bac8ed

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

CLAUDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,10 @@ Git hooks will automatically run linting on **all changed files (staged + unstag
4848
- **Do NOT add changelog entries for**: linting fixes, code formatting, internal refactoring, test updates, documentation fixes
4949
- Non-user-visible changes don't need changelog entries even if they modify code
5050
- **Format requirements**:
51-
- Always link to the PR: `[PR #123](https://github.com/shakacode/react_on_rails/pull/123)`
51+
- Always link to the PR: `[PR 1818](https://github.com/shakacode/react_on_rails/pull/1818)` (no hash symbol)
5252
- Always link to the author: `by [username](https://github.com/username)`
5353
- Keep formatting consistent with existing entries
54-
- When releasing a version, update the version diff links at the bottom of CHANGELOG.md
54+
- When releasing a version, run `bundle exec rake update_changelog` to update version headers and diff links
5555
- **For breaking changes**: Use bold formatting and link to migration documentation (e.g., `**Breaking**: Description. See [Migration Guide](docs/vX_upgrade.md)`)
5656

5757
## ⚠️ FORMATTING RULES

0 commit comments

Comments
 (0)