Skip to content

Commit 3b95ff2

Browse files
authored
Document contributing commit message rules (#548)
These rules are critical for the readability of our git history. Since I reference these rules often in PRs, they belong at the top of our Contributing section.
2 parents 0db0af3 + 3e31b67 commit 3b95ff2

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,11 @@ cargo update -p zstd-sys --precise 2.0.8+zstd.1.5.5
110110

111111
## Contributing
112112

113+
### Commit Messages
114+
115+
The git repository is our source of truth for development history. Therefore the commit history is the most important communication
116+
artifact we produce. Commit messages must follow [the seven rules in this guide by cbeams](https://cbea.ms/git-commit/#seven-rules).
117+
113118
### Nix Development Shells
114119

115120
Where nix is available (NixOS or

0 commit comments

Comments
 (0)