diff options
| author | Quentin Young <qlyoung@nvidia.com> | 2021-04-09 12:55:33 -0400 |
|---|---|---|
| committer | Quentin Young <qlyoung@nvidia.com> | 2021-04-09 12:55:33 -0400 |
| commit | 7bd4560bbd9f79e7dc05ed189f641dc538d4d1d3 (patch) | |
| tree | 140c75feb8c517dabbc1f8b49c9c544116ac82dc /doc/developer/workflow.rst | |
| parent | f99b9d6eb1c058ba00d33ac7ad032187d5c6efb8 (diff) | |
doc: describe acceptable commit messages
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>
Diffstat (limited to 'doc/developer/workflow.rst')
| -rw-r--r-- | doc/developer/workflow.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst index abdbea5a9c..b4ddec10c9 100644 --- a/doc/developer/workflow.rst +++ b/doc/developer/workflow.rst @@ -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 ------------------ |