Skip to content

Commit

Permalink
docs: clarify commit message requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
barafael committed Mar 2, 2025
1 parent dbd9ec6 commit ef1d25f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -397,14 +397,14 @@ A good commit message should describe what changed and why.

1. The first line should:

* be prefixed with the name of the module being changed; usually this is the
same as the M-* label on the PR
* start with an imperative verb
* contain a short description of the change (preferably 50 characters or less,
and no more than 72 characters)
* be entirely in lowercase with the exception of proper nouns, acronyms, and
the words that refer to code, like function/variable names
* start with an imperative verb
* not have a period at the end
* be prefixed with the name of the module being changed; usually this is the
same as the M-* label on the PR

Examples:

Expand Down

0 comments on commit ef1d25f

Please sign in to comment.