Add a note about commit message titles being 50-70 character in length

Requested by @levitte in #30075

Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Tom Cosgrove <tom.cosgrove@arm.com>
Reviewed-by: Neil Horman <nhorman@openssl.org>
MergeDate: Sat Feb 28 14:04:35 2026
(Merged from https://github.com/openssl/openssl/pull/30148)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index d4a80e7e47b2799958263aa4782e06e3d7439176..3fb7a45961841679435bf100dc4b16c5095a4794 100644 (file)
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -5,6 +5,8 @@ Contributors guide: https://github.com/openssl/openssl/blob/master/CONTRIBUTING.
 
 Include a clear description of the issue or feature above this comment if not already provided. This should briefly outline the issue or feature being addressed, along with any relevant implementation details. For performance improvements, include benchmark results as well.
 
+Please always add meaningful commit messages.  Commit message titles (the first line of each commit message which should be separated by an empty line from the rest of the message) should be kept to 50-70 characters if possible.  Further details and Fixes #issue number annotations should be placed in the commit message body (i.e, after the empty line).
+
 Pull requests and commits should be self-contained, allowing readers to understand what changed and why without needing to reference related issues or having prior knowledge. Individual commit messages should include all relevant details to ensure future contributors can easily follow the git history. Clearly explain what is changing and why, and feel free to include detailed (long) descriptions when beneficial to understanding.
 
 If this fixes a GitHub issue, make sure to have a line saying 'Fixes #XXXX' (without quotes) in the commit message.

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 388f9a8e13413537bebbb0cde755165dc070c601..20bf3910a1e3792378e5bb46b0798de42069b7c3 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -29,12 +29,15 @@ automated tools.
 
 Provide a clear description of the issue or feature being addressed,
 including any relevant implementation details and, for performance
-improvements, benchmark results. Pull requests and commits should be
-self-contained, enabling readers to understand what changed and why
-without needing to reference related issues or having prior knowledge. Commit
-messages should include all relevant details to help future contributors
-follow the git history, with clear explanations of what is changing
-and why. Long descriptions are encouraged if they aid understanding.
+improvements, benchmark results.
+
+Pull requests and commits should be self-contained, enabling readers to
+understand what changed and why without needing to reference related
+issues or having prior knowledge.  Commit messages should include all
+relevant details to help future contributors follow the git history,
+with clear explanations of what is changing and why.  Long descriptions
+are encouraged if they aid understanding.  Commit message titles (their
+first line) should be kept to 50-70 characters if possible.
 
 To make it easier to review and accept your pull request, please follow these
 guidelines: