Add changelog discipline guideline to git-workflow skill#48
Merged
Conversation
Codifies the rule that user-facing changelog entries describe what changed from a user/operator's perspective — not how the work was tracked or organized internally. The new "Changelog Discipline" section in `references/commits.md` covers: - **Drop:** spec/task IDs, internal session references, internal terms (e.g., `Q1`/`Q2`/`Q3` question numbers from a Triage Gate, gate-logic notation, hook IDs that aren't user-facing). - **Keep:** what changed, why it matters, references to public artifacts the user knows about (`ADR-NNN`, public CLI flags, documented paths). - **Style:** backticks for code references, user-perspective prose, Keep-a-Changelog grouping (`Added`/`Changed`/`Fixed`/`Removed`). - **Auto-generated entries:** treat `loaf release --pre-merge` output as a draft; curate before bumping. The Topics table in `SKILL.md` updated to surface the new section in the "Use When" hint. Originated from the v2.0.0-dev.38/39 release cycle, where the user flagged that auto-generated and even drafted curated changelog content referenced internal Triage Gate question-numbering — meaningless to users reading the published CHANGELOG.
Session journal updates from the v2.0.0-dev.38/39 release cycle and the changelog-discipline follow-up. Captures decisions, discoveries, and the scripted close marker (`session(wrap)`).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Codifies a guideline that emerged from the v2.0.0-dev.38/39 release cycle: user-facing CHANGELOG entries describe what changed from a user/operator's perspective — not how the work was tracked or organized internally.
Ships as
v2.0.0-dev.40.Changes
content/skills/git-workflow/references/commits.md— new "Changelog Discipline" section, slotted between "Pull Request Format" and "Critical Rules":ADR-NNN, public CLI flags, documented file paths)loaf release --pre-mergeoutput as a draft; curate before bumpingcontent/skills/git-workflow/SKILL.md— Topics table updated to surface the new section in the "Use When" hint..agents/sessions/20260502-184737-session.mdwrap-up summary).Test plan
npm run typecheckcleanloaf buildclean across all 6 targetsloaf release --pre-merge --bump prerelease— version + CHANGELOG updated, build refreshed, release commit landed