Repository navigation
Commit 10ec385
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,14 @@ | |||
| 1 | + # Commit messages | ||
| 2 | + | ||
| 3 | + Every commit must have a descriptive title and a substantive body. Title-only | ||
| 4 | + commit messages are not acceptable. | ||
| 5 | + | ||
| 6 | + The body must explain the problem or motivation, what changed, and why the | ||
| 7 | + chosen approach addresses it. Include relevant behavior before and after the | ||
| 8 | + change, design decisions, limitations, and validation results. Scale the detail | ||
| 9 | + to the change; do not add boilerplate or claim checks that were not run. | ||
| 10 | + | ||
| 11 | + Commit messages must stand on their own. Put the information needed to understand | ||
| 12 | + and review the change in the commit body, even when it also appears in a pull | ||
| 13 | + request description. PR and issue links may provide additional context, but must | ||
| 14 | + not substitute for that explanation. | ||
0 commit comments