hygiene.md (970B)
1 # Commit hygiene 2 3 You are given a commit message, the per-file statistics, and the subjects of recent 4 commits in the same repository. 5 6 - `message-omits-a-change` — the diff contains a change the message does not 7 describe. A rename swept into a commit about something else is the common case. 8 - `message-claims-more` — the message describes work the diff does not contain. 9 - `two-changes` — the diff is two unrelated changes that should be two commits. 10 Judge by whether one could be reverted without the other. 11 - `subject-not-local-style` — the subject departs from the convention visible in the 12 recent subjects you were given. Follow what the repository does, not a house style 13 from elsewhere; if the recent subjects disagree with each other, say nothing. 14 - `body-explains-what-not-why` — the body restates what the diff shows instead of 15 saying why it was done. 16 17 The statistics are enough to notice a commit doing two things. Do not ask to see more.