diff options
| author | Ben Pfaff <blp@ovn.org> | 2016-12-01 15:59:29 -0800 |
|---|---|---|
| committer | Ben Pfaff <blp@ovn.org> | 2016-12-02 08:49:38 -0800 |
| commit | 92caf18899dfb819713fc447ae7926d31711fecf (patch) | |
| tree | fb71e6f7257afaa416183728db500188d07c6962 /CONTRIBUTING.rst | |
| parent | 2ee39aec34dc8c41206cf0b039c5620ceb9deb2e (diff) | |
| download | openvswitch-92caf18899dfb819713fc447ae7926d31711fecf.tar.gz | |
CONTRIBUTING.rst: Update patch summary and description style guidelines.
Suggested-by: Joe Stringer <joe@ovn.org>
Suggested-at: https://mail.openvswitch.org/pipermail/ovs-dev/2016-November/325513.html
Signed-off-by: Ben Pfaff <blp@ovn.org>
Acked-by: Stephen Finucane <stephen@that.guru>
Acked-by: Justin Pettit <jpettit@ovn.org>
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 867562ef3..2b262caad 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." Try to keep the summary short, about + 50 characters wide. 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 ------------------------------ |