From 2c81a8331d07a842eb859a409edf0bcc605a3cf7 Mon Sep 17 00:00:00 2001 From: Armando Montanez Date: Thu, 9 Jun 2022 16:02:14 -0700 Subject: [PATCH] docs: Correct commit summary length guidlines 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 Commit-Queue: Auto-Submit Reviewed-by: Wyatt Hepler --- docs/contributing.rst | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index a373064545..744a7d1d02 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -86,11 +86,9 @@ it to the ``.git\hooks`` directory in the Pigweed repository. Commit message -------------- -Pigweed commit messages follow the `50/72 style -`_ (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 ` of well and ill-formed commit messages are provided below.