Skip to content

Commit

Permalink
Document contributing commit message rules
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
DanGould authored Feb 21, 2025
1 parent 4ba2d8c commit 413ede5
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,11 @@ cargo update -p zstd-sys --precise 2.0.8+zstd.1.5.5

## Contributing

### Commit Messages

The git repository is our source of truth for development history. Therefore the commit history is the most important communication
artifact we produce. Commit messages must follow [the seven rules in this guide by cbeams](https://cbea.ms/git-commit/#seven-rules).

### Nix Development Shells

Where nix is available (NixOS or
Expand Down

0 comments on commit 413ede5

Please sign in to comment.