Skip to content

Commit f652cdf

Browse files
cknittclaude
andcommitted
Require a description in every commit record
The skill listed only the subject and Signed-off-by as required, and the expected line or two of prose sat under the object blocks' section, so a subject alone read as enough. It now requires a description, prose or a Why: section, and shows a small commit next to the full example. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AzPS5F8RDSGZ6dhfK6NdZp Signed-off-by: Christoph Knittel <ck@cca.io>
1 parent 507e040 commit f652cdf

1 file changed

Lines changed: 24 additions & 8 deletions

File tree

‎.claude/skills/records/SKILL.md‎

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,25 @@ Breaking: <what existing code or tooling stops working, and the migration>
4949
Signed-off-by: Name <email>
5050
```
5151

52-
- The subject and `Signed-off-by` are required. The message ends with its
53-
trailers, git's `Key: value` lines (`Co-Authored-By:`, `Fixes:` or any
54-
other one-word key), `Signed-off-by` last; the page lists the
55-
`Co-Authored-By` names and draws no other trailer. Every section is
56-
optional.
52+
A commit without object blocks, such as a script change, is its subject
53+
and a line or two of prose:
54+
55+
```
56+
Draw handles starting with a digit as code in the comment
57+
58+
GitHub usernames may start with a digit, so `@0x` in a commit message
59+
would have mentioned a user; the comment now draws it as code as well.
60+
61+
Signed-off-by: Name <email>
62+
```
63+
64+
- The subject, a description and `Signed-off-by` are required: the
65+
description says why the commit is made, as a line or two of prose or
66+
a `Why:` section, and object blocks then show what it changes. Every
67+
other section is optional. The message ends with its trailers, git's
68+
`Key: value` lines (`Co-Authored-By:`, `Fixes:` or any other one-word
69+
key), `Signed-off-by` last; the page lists the `Co-Authored-By` names
70+
and draws no other trailer.
5771
- A section starts at a line `Why:`, `Review:`, `Breaking:`, an object
5872
block's heading, an `Example:` alone on its line, or a `Before (<form>):`
5973
or `After (<form>):` heading, and holds the text after its colon and the
@@ -159,11 +173,13 @@ The table lists the common kinds.
159173
`-dce` and `-termination` select the other analyses.
160174
- A form of another name is drawn as text.
161175

162-
## When to add a block
176+
## What a commit holds
163177

164-
A commit gets one object block for each object it changes, with the
178+
Every commit says why it is made. A commit that changes what the compiler
179+
or a tool does gets one object block for each object it changes, with the
165180
smallest example that shows the change. A refactor, a test, a script or a
166-
review fix is a subject and a line or two of prose.
181+
review fix needs no block, only its subject and a line or two of prose; a
182+
review fix names the finding it answers.
167183

168184
## Rendering
169185

0 commit comments

Comments
 (0)