Skip to content

Commit

Permalink
docs: Correct commit summary length guidlines
Browse files Browse the repository at this point in the history
pw_presumit has been enforcing a 72-character column limit for commit
bodies AND summaries.

Change-Id: I252b18104f749f687bf684d9eb5d4b809b70376f
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/97683
Pigweed-Auto-Submit: Armando Montanez <amontanez@google.com>
Commit-Queue: Auto-Submit <auto-submit@pigweed.google.com.iam.gserviceaccount.com>
Reviewed-by: Wyatt Hepler <hepler@google.com>
  • Loading branch information
armandomontanez authored and CQ Bot Account committed Jun 10, 2022
1 parent fd7c677 commit 2c81a83
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,11 +86,9 @@ it to the ``.git\hooks`` directory in the Pigweed repository.
Commit message
--------------
Pigweed commit messages follow the `50/72 style
<https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html>`_ (a
maximum of 50 characters in the commit title, and a 72 character width limit in
the commit message body). Commit titles should be prefixed with the name of the
module that the commit is affecting. :ref:`Examples
Pigweed commit message bodies and summaries are limited to 72 characters wide
to improve readability. Commit summaries should also be prefixed with the name
of the module that the commit is affecting. :ref:`Examples
<docs-contributing-commit-message-examples>` of well and ill-formed commit
messages are provided below.

Expand Down

0 comments on commit 2c81a83

Please sign in to comment.