proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-08-05 04:40:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: describe acceptable commit messages

Browse Source 
Update workflow.rst to state that commit messages consisting solely of
program output, or that otherwise fail to adequately summarize the
changes being made, are unacceptable.

Signed-off-by: Quentin Young <qlyoung@nvidia.com>
This commit is contained in:
Quentin Young 2021-04-09 12:55:33 -04:00
parent f99b9d6eb1
commit 7bd4560bbd
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/developer/workflow.rst
View File

@ -500,10 +500,22 @@ made. For example, a change in :file:`bgpd/rfapi` would be formatted as::
The first line should be no longer than 50 characters. Subsequent lines should
be wrapped to 72 characters.
The purpose of commit messages is to briefly summarize what the commit is
changing. Therefore, the extended summary portion should be in the form of an
English paragraph. Brief examples of program output are acceptable but if
present should be short (on the order of 10 lines) and clearly demonstrate what
has changed. The goal should be that someone with only passing familiarity with
the code in question can understand what is being changed.
Commit messages consisting entirely of program output are *unacceptable*. These
do not describe the behavior changed. For example, putting VTYSH output or the
result of test runs as the sole content of commit messages is unacceptable.
You must also sign off on your commit.
.. seealso:: :ref:`signing-off`
Source File Header
------------------