RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2024-12-22 03:22:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: SubmittingPatches: clarify PR title section

Browse Source 
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>
This commit is contained in:
Nathan Cutler 2017-08-22 11:06:04 +02:00
parent f3d01c1a59
commit c8cefc3a5b
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
SubmittingPatches.rst
View 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
^^^^^^^^^^^^^^