X-Git-Url: http://git.cascardo.eti.br/?p=cascardo%2Fovs.git;a=blobdiff_plain;f=CONTRIBUTING.md;h=6f69cfff0b96b5a01f4e014c5972e57e4e85a499;hp=97ab9cb840aee768e9a4b7a191b7834fa7631f77;hb=HEAD;hpb=121daded51b9798fe3722824b27a05c16806cbd1 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 97ab9cb84..6f69cfff0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,8 +29,9 @@ In particular: Testing is also important: - - A patch that modifies existing code should be tested with - `make check` before submission. + - A patch that modifies existing code should be tested with `make + check` before submission. Please see INSTALL.md, under + "Self-Tests", for more information. - A patch that adds or deletes files should also be tested with `make distcheck` before submission. @@ -214,6 +215,14 @@ Examples of common tags follow. Reported-at: http://openvswitch.org/pipermail/dev/2014-June/040952.html + Submitted-at: + + If a patch was submitted somewhere other than the Open vSwitch + development mailing list, such as a GitHub pull request, this header can + be used to reference the source. + + Submitted-at: https://github.com/openvswitch/ovs/pull/92 + VMware-BZ: #1234567 ONF-JIRA: EXT-12345 @@ -231,6 +240,16 @@ Examples of common tags follow. in old change log entries. (They are obsolete because they do not tell the reader what bug tracker is referred to.) + Fixes: 63bc9fb1c69f (“packets: Reorder CS_* flags to remove gap.”) + + If you would like to record which commit introduced a bug being fixed, + you may do that with a “Fixes” header. This assists in determining + which OVS releases have the bug, so the patch can be applied to all + affected versions. The easiest way to generate the header in the + proper format is with this git command: + + git log -1 --pretty=format:"Fixes: %h (\"%s\")" --abbrev=12 COMMIT_REF + Developer's Certificate of Origin ---------------------------------