From 16a15621ddc112fdd1f6e519c98140e3efd7b955 Mon Sep 17 00:00:00 2001 From: rzen Date: Sat, 20 Jun 2026 14:55:03 -0400 Subject: [PATCH] Document the changelog convention in CLAUDE.md 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 --- CLAUDE.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CLAUDE.md b/CLAUDE.md index 38b7dcd..fbc308f 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -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.