blob: 2326711d9656abd74c7d3c000229dff640659358 [file] [log] [blame] [view]
jfarrell347a5eb2014-04-05 12:20:07 -04001## Process used by committers to review and submit patches
2
Konrad Grochowski3bc64242015-02-04 16:43:26 +010031. Make sure that there is an issue for the patch(s) you are about to commit in our [Jira issue tracker](http://issues.apache.org/jira/browse/THRIFT)
4
jfarrell347a5eb2014-04-05 12:20:07 -040051. Check out the latest version of the source code
Konrad Grochowski3bc64242015-02-04 16:43:26 +01006
Robert Lua1390822018-12-27 23:57:35 +08007 * git clone https://github.com/apache/thrift.git thrift
jfarrell347a5eb2014-04-05 12:20:07 -04008
91. Apply the patch
Konrad Grochowski3bc64242015-02-04 16:43:26 +010010
11 * curl https://issues.apache.org/jira/... |git apply --ignore-space-change
12
13 or
14
15 * curl https://github.com/<GitHub User>/thrift/commit/<Commit ID>.patch |git apply --ignore-space-change
16
17
jfarrell347a5eb2014-04-05 12:20:07 -0400181. Inspect the applied patch to ensure that all [Legal aspects on Submission of Contributions (Patches)](http://www.apache.org/licenses/LICENSE-2.0.html#contributions) are met
19
201. Run the necessary unit tests and cross language test cases to verify the patch
21
221. Commit the patch
23
Konrad Grochowski3bc64242015-02-04 16:43:26 +010024 git --config user.name "Your Name"
25 git --config user.email "YourApacheID@apache.org"
26 git add -A
27 git commit
28
jfarrell347a5eb2014-04-05 12:20:07 -0400291. The commit message should be in the format:
jfarrell347a5eb2014-04-05 12:20:07 -040030
Jens Geyer2a954412019-09-22 11:04:07 +020031 THRIFT-####:<Jira description>
Konrad Grochowski3bc64242015-02-04 16:43:26 +010032 Client: <component>
33 Patch: <Name of person contributing the patch>
jfarrell347a5eb2014-04-05 12:20:07 -040034
Konrad Grochowski3bc64242015-02-04 16:43:26 +010035 Description of what was fixed or addressed.
36
Jens Geyer2a954412019-09-22 11:04:07 +020037 If this is a github pull request then add below comment to automaticaly close GitHub request,
38 where #NNNN is the PR number:
39
40 This closes #NNNN
jfarrell347a5eb2014-04-05 12:20:07 -040041
42
431. Double check the patch committed and that nothing was missed then push the patch
44
Konrad Grochowski3bc64242015-02-04 16:43:26 +010045 git status
46 git show HEAD
47 git push origin master
jfarrell347a5eb2014-04-05 12:20:07 -040048
Konrad Grochowski3bc64242015-02-04 16:43:26 +010049
jfarrell347a5eb2014-04-05 12:20:07 -0400501. Resolve the jira issue and set the following for the changelog
51
Konrad Grochowski3bc64242015-02-04 16:43:26 +010052 * Component the patch is for
53 * fixVersion to the current version on master