Suggested-by: Joe Stringer <[email protected]>
Suggested-at:
https://mail.openvswitch.org/pipermail/ovs-dev/2016-November/325513.html
Signed-off-by: Ben Pfaff <[email protected]>
---
CONTRIBUTING.rst | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 867562e..721371e 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -94,7 +94,11 @@ Where:
multiple distinct pieces of code.
``<summary>``:
- briefly describes the change.
+
+ briefly describes the change. Use the the imperative form,
+ e.g. "Force SNAT for multiple gateway routers." or "Fix daemon exit
+ for bad datapaths or flows." This turns the summary into a
+ sentence, so please end it with a period.
The subject, minus the ``[PATCH <n>/<m>]`` prefix, becomes the first line of
the commit's change log message.
@@ -106,7 +110,9 @@ The body of the email should start with a more thorough
description of the
change. This becomes the body of the commit message, following the subject.
There is no need to duplicate the summary given in the subject.
-Please limit lines in the description to 79 characters in width.
+Please limit lines in the description to 75 characters in width. That
+allows the description to format properly even when indented (e.g. by
+"git log" or in email quotations).
The description should include:
@@ -342,6 +348,8 @@ openvswitch please sign off your work. The sign off
certifies the following:
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
+See also http://developercertificate.org/.
+
Feature Deprecation Guidelines
------------------------------
--
2.10.2
_______________________________________________
dev mailing list
[email protected]
https://mail.openvswitch.org/mailman/listinfo/ovs-dev
