Difference between revisions of "CSIT/Submitting Patches"
From fd.io
< CSIT
Dwallacelf (Talk | contribs) (→Commit Message Headline Nomenclature) |
Dwallacelf (Talk | contribs) (→Commit Message Headline Nomenclature) |
||
| Line 5: | Line 5: | ||
== Commit Message Headline Nomenclature == | == Commit Message Headline Nomenclature == | ||
| − | When committing code to the CSIT repository and pushing patches to gerrit, please add a prefix to the headline of the commit message that | + | When committing code to the CSIT repository and pushing patches to gerrit, please add a prefix to the headline of the commit message that contains the Jira ticket id, "DO_NOT_MERGE" or both: |
| − | *<code> | + | *<b><code>CSIT-<###>:</code></b> <i>Summary of patch</i> |
| − | *< | + | *<b><code>DO_NOT_MERGE:</code></b> <i>Summary of patch</i> |
| − | * both ( <code>DO_NOT_MERGE CSIT-<###>:</code> ) | + | * both ( <b><code>DO_NOT_MERGE CSIT-<###>:</code></b> <i>Summary of patch</i> ) |
| + | Note: DO_NOT_MERGE should always be at the beginning of the line when present. | ||
Here are some examples: | Here are some examples: | ||
Revision as of 04:13, 1 July 2016
Submitting Patches
The VPP wiki has a nice set of instructions for Pushing Code with git review. The same process is recommended for submitting patches to the CSIT git repository.
Commit Message Headline Nomenclature
When committing code to the CSIT repository and pushing patches to gerrit, please add a prefix to the headline of the commit message that contains the Jira ticket id, "DO_NOT_MERGE" or both:
CSIT-<###>:Summary of patchDO_NOT_MERGE:Summary of patch- both (
DO_NOT_MERGE CSIT-<###>:Summary of patch )
Note: DO_NOT_MERGE should always be at the beginning of the line when present.
Here are some examples:
CSIT-60: Create l2-vlan-dot1ad libraries for perf testing
DO_NOT_MERGE: test VXLAN + VLAN on newer version of VPP.
DO_NOT_MERGE CSIT-156: DPDK support for Nested VM image
Using this nomenclature makes the CSIT gerrit open patches list easier to manage for CSIT committers and code reviewers.
