rzen/workouts
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

Document the changelog convention in CLAUDE.md

Browse Source 
Record how CHANGELOG.md is written: end-user-facing (it renders
in-app via IndieAbout), grouped by month, one blank-line-separated
paragraph per entry with no dash markers, derived from but rewritten
off the git log, keeping only user-significant changes while
splitting multi-change commits and collapsing duplicates.

Claude-Session: https://claude.ai/code/session_01A9CfUa4E9Zd5swfoNsYPs7
This commit is contained in:
Rouslan Zenetl
2026-06-20 14:55:03 -04:00
parent 94a737ebcc
commit 16a15621dd
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CLAUDE.md
+11
View File
@@ -79,3 +79,14 @@ Workout (1) ──cascade──> (many) WorkoutLog
- **Preview support**: `PersistenceController.preview` for SwiftUI previews
- **Color system**: Custom color extensions for consistent theming (`Color.color(from:)`)
- **Date formatting**: Extensions in `Date+Extensions.swift`
## Changelog
`CHANGELOG.md` is shown in-app via IndieAbout, so it is written for end users, not developers:
- Group entries by month; newest month first.
- Write each entry as its own blank-line-separated paragraph — no bullet or dash markers, which the Apple inline-Markdown subset IndieAbout renders doesn't style.
- Derive entries from the git log, but rewrite (don't copy) each into a concise one-liner describing the crux of the change in end-user-understandable terms.
- Include only changes significant to an end user; skip internal/tooling/refactor-only commits.
- When one commit holds several user-facing changes, break them into separate paragraphs.
- When several commits address the same user-facing change, collapse them into one paragraph.