CONTRIBUTING.md: Add extra commit message rule

extra-commit-rule
Andri Yngvason 2023-02-26 09:53:47 +00:00
parent 4700716d00
commit ab1fbdf98a
1 changed files with 23 additions and 1 deletions

View File

@ -3,7 +3,8 @@
## Commit Messages
Please, try to write good commit messages. Do your best to follow these 7 rules,
borrowed from [Chris Beams](https://chris.beams.io/posts/git-commit/):
borrowed from [Chris Beams](https://chris.beams.io/posts/git-commit/), plus 1
extra rule:
1. Separate subject from body with a blank line
2. Limit the subject line to 50 characters
@ -12,10 +13,31 @@ borrowed from [Chris Beams](https://chris.beams.io/posts/git-commit/):
5. Use the imperative mood in the subject line
6. Wrap the body at 72 characters
7. Use the body to explain what and why vs. how
8. (Extra) Prefix the subject line with the component that's modified
If you wish to know why we follow these rules, please read Chris Beams' blog
entry, linked above.
Rule number 8 allows us to quickly gauge if a given commit is relevant to what
we're looking for when skimming the log. It adds consistency and simplifies the
message. For example
```
ctl-client: Print trailing newline for events
```
is better than
```
Print trailing newline for events in ctl-client
```
**Example:**
```
ctl-client: Print trailing newline for events
If someone wants to parse this instead of using jq, a trailing
newline delimits the end of the event.
```
## Style
This project follows the the