summaryrefslogtreecommitdiff
path: root/docs/contributing
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-12-07 18:31:53 +0100
committerChristian Poessinger <christian@poessinger.com>2019-12-07 18:31:53 +0100
commitd247468e0379d70e26e30dc26bdfe13da8e62939 (patch)
tree419c3eea70da9d0840274406325457da97c6f182 /docs/contributing
parent1cf56e249ca66a7107f429296bdd2543dbfc7e80 (diff)
downloadvyos-documentation-d247468e0379d70e26e30dc26bdfe13da8e62939.tar.gz
vyos-documentation-d247468e0379d70e26e30dc26bdfe13da8e62939.zip
development: reword of commit messages
Diffstat (limited to 'docs/contributing')
-rw-r--r--docs/contributing/development.rst14
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/contributing/development.rst b/docs/contributing/development.rst
index 12d706f3..f1461480 100644
--- a/docs/contributing/development.rst
+++ b/docs/contributing/development.rst
@@ -64,15 +64,15 @@ In general, use an editor to create your commit messages rather than passing
them on the command line. The format should be and is inspired by this blog
post: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
-* A single, short, summary of the commit (recommended 70 characters or less,
- but not exceeding 80 characters)
+* A single, short, summary of the commit (recommended 50 characters or less,
+ not exceeding 80 characters)
- * Add a prefix of the changed component to your commit headline, e.g. ``snmp:
- T1111:`` or ``ethernet: T2222:``. If multiple components are touched by this
- commit, you can use multiple prefixes, e.g.: ``snmp: ethernet:``
+ * Add prefix of changed component to your commit headline, e.g. ``snmp:
+ T1111:`` or ``ethernet: T2222:``. If multiple components are touched by
+ this commit, you can use multiple prefixes, e.g.: ``snmp: ethernet:``
-* Followed by a blank line (this is mandatory - else Git will treat the whole
- commit message as the headline only)
+* Followed by a blank line (this line is mandatory - else Git will treat the
+ whole commit message as the headline only)
* Followed by a message which describes all the details like: