Skip to content

Commit 9650740

Browse files
justin808claude
andcommitted
Document beta changelog curation process in CLAUDE.md
Added comprehensive guidelines for curating changelog entries when consolidating beta releases: - Clear criteria for what to remove (developer-only, beta-specific, Pro features) - Clear criteria for what to keep (user-facing fixes, breaking changes) - Investigation process with git commands - Reference to PR #2072 as a complete example This documents the complex analysis process performed during the v16.2.0.beta.11 changelog cleanup to help future developers with similar tasks. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 9dbfa29 commit 9650740

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

CLAUDE.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,50 @@ When making changes, update the **appropriate changelog(s)**:
214214
- Pro: `cd react_on_rails_pro && bundle exec rake update_changelog`
215215
- **Examples**: Run `grep -A 3 "^#### " CHANGELOG.md | head -30` to see real formatting examples
216216

217+
### Beta Release Changelog Curation
218+
219+
When consolidating beta versions into a stable release, carefully curate entries to include only user-facing changes:
220+
221+
**Remove these types of entries:**
222+
223+
1. **Developer-only tooling**:
224+
- yalc publish fixes (local development tool)
225+
- Git dependency support (contributor workflow)
226+
- CI/build script improvements
227+
- Internal tooling changes
228+
229+
2. **Beta-specific fixes**:
230+
- Bugs introduced during the beta cycle (not present in last stable)
231+
- Fixes for new beta-only features (e.g., bin/dev in 16.2.0.beta)
232+
- Generator handling of beta/RC version formats
233+
234+
3. **Pro-specific features** (move to Pro changelog):
235+
- Node renderer fixes/improvements
236+
- Streaming-related changes
237+
- Async loading features (Pro-exclusive)
238+
239+
**Keep these types of entries:**
240+
241+
1. **User-facing fixes**:
242+
- Bugs that existed in previous stable release (e.g., 16.1.x)
243+
- Compatibility fixes (Rails version support, etc.)
244+
- Performance improvements affecting all users
245+
246+
2. **Breaking changes**:
247+
- API changes requiring migration
248+
- Removed methods/features
249+
- Configuration changes
250+
251+
**Investigation process:**
252+
253+
For each suspicious entry:
254+
1. Check git history: `git log --oneline <last_stable>..<current_beta> -- <file>`
255+
2. Determine when bug was introduced (stable vs beta cycle)
256+
3. Verify whether fix applies to stable users or only beta users
257+
4. Check PR description for context about what was broken
258+
259+
**Example reference:** See [PR #2072](https://github.com/shakacode/react_on_rails/pull/2072) for a complete example of beta changelog curation with detailed investigation notes.
260+
217261
## ⚠️ FORMATTING RULES
218262

219263
**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)