Skip to content

Commit 582fb7d

Browse files
committed
Clarify commit message format
1 parent c3f4ac9 commit 582fb7d

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/contributing/docs/git.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,12 @@ If your PR closes more than one issue, add such a line for each issue.
3838
Commit messages
3939
---------------
4040

41-
* In your commit message, convey the nature of the change and possibly the reason why it was made.
41+
* One-line commit messages are sufficient for documentation changes. Try keeping it 50 characters or less.
42+
* Convey the nature of the change and possibly the reason why it was made.
4243
* Don't specify the files you've changed or the issue you're working on.
4344
The file names can be looked up in the "Files" section of the PR, and the PR description has the issue number(s).
4445
* Use the imperative mood.
4546
* Start with a capital letter, don't add ending punctuation.
46-
* Try to stick to 50 characters or so.
4747
* (Optional) Use the telegraphic style, or "headlinese", dropping the articles.
4848

4949
Good examples

0 commit comments

Comments
 (0)