Skip to content

Fix incorrect claim about how GitHub builds squash commit messages #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jnasbyupgrade wants to merge 1 commit into from
Closed

Fix incorrect claim about how GitHub builds squash commit messages #84

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,9 @@ Write it accordingly:
- Do NOT add a marker delimiting the "commit message" from "the rest". Just let the
opening carry its own weight, with any extra context following after it.
- Do NOT hard-wrap paragraphs: write each paragraph as a single long line (blank line
between paragraphs). Hard-wrapping at ~80 columns conflicts with how GitHub builds the
squash commit message from the description.
between paragraphs). The maintainer copies the opening more or less directly into the
squash commit message; hard-wrapped line breaks would carry over into that commit
message too.
- Length past the opening is fine — backstory and detail are often worth keeping. Being
hard to *scan* is the actual problem: if there's enough detail to justify it, give the
rest real structure (headers, bullet lists, separate sections for "what changed" vs.
Expand Down
Loading