]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: SubmittingPatches: clarify PR title section 17143/head
authorNathan Cutler <ncutler@suse.com>
Tue, 22 Aug 2017 09:06:04 +0000 (11:06 +0200)
committerNathan Cutler <ncutler@suse.com>
Tue, 22 Aug 2017 09:06:04 +0000 (11:06 +0200)
There is no real limit on the length of PR titles, other than whatever limit is
imposed by the GitHub GUI/API.

Signed-off-by: Nathan Cutler <ncutler@suse.com>
SubmittingPatches.rst

index 0f20155b76635286c6f374318bfcccdd5c34f6b4..33345045b7f0e064c351fa40038acd87de092613 100644 (file)
@@ -392,16 +392,19 @@ Title of pull requests and title of commits
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The text up to the first empty line in a commit message is the commit
-title. Ideally it is a single short line less than 50 characters,
+title. Ideally it is a single short line of at most 72 characters,
 summarizing the change. It is required to prefix it with the
 subsystem or module you are changing. For instance, the prefix
 could be "doc:", "osd:", or "common:". One can use::
 
      git log
 
-for more examples. Please use this convention for naming pull requests
-(subsystem: short description) also, as it feeds directly into the script
-that generates release notes and it's tedious to clean up at release time.
+for more examples. Please use this "subsystem: short description"
+convention for naming pull requests (PRs) also, as it feeds directly
+into the script that generates release notes and it's tedious to clean
+up at release time. This document places no limit on the length of PR
+titles, but be aware that they are subject to editing as part of the
+release process.
 
 Commit message
 ^^^^^^^^^^^^^^