diff options
| author | Nathan Cutler <ncutler@suse.com> | 2017-08-22 11:06:04 +0200 |
|---|---|---|
| committer | Nathan Cutler <ncutler@suse.com> | 2017-08-22 11:06:04 +0200 |
| commit | c8cefc3a5b09830f63551413f8bc8c02c8de10a9 (patch) | |
| tree | 31f866a64dc333a3b12cd170f42419e09d3a28c2 /SubmittingPatches.rst | |
| parent | Merge pull request #17115 from amitkumar50/cov-osd-1 (diff) | |
| download | ceph-c8cefc3a5b09830f63551413f8bc8c02c8de10a9.tar.xz ceph-c8cefc3a5b09830f63551413f8bc8c02c8de10a9.zip | |
doc: SubmittingPatches: clarify PR title section
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>
Diffstat (limited to 'SubmittingPatches.rst')
| -rw-r--r-- | SubmittingPatches.rst | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/SubmittingPatches.rst b/SubmittingPatches.rst index 0f20155b766..33345045b7f 100644 --- a/SubmittingPatches.rst +++ b/SubmittingPatches.rst @@ -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 ^^^^^^^^^^^^^^ |