Skip to content

Commit

Permalink
THRIFT-2450 - include HowToContribute in the src repo
Browse files Browse the repository at this point in the history
Client: build
Patch: jfarrell

Reorganized docs and adds HowToContribute to the code base.
  • Loading branch information
jfarrell committed Apr 5, 2014
1 parent 6cf0ffc commit 347a5eb
Show file tree
Hide file tree
Showing 7 changed files with 112 additions and 0 deletions.
67 changes: 67 additions & 0 deletions doc/HowToCommit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
## Process used by committers to review and submit patches

1. Make sure that there is an issue for the patch(s) you are about to commit in our [Jira issue tracker]({{ conf.jira_url }})

1. Check out the latest version of the source code

* git clone https://git-wip-us.apache.org/repos/asf/thrift.git thrift

1. Apply the patch

* curl https://issues.apache.org/jira/... |git apply --ignore-space-change

or

* curl https://github.com/<GitHub User>/thrift/commit/<Commit ID>.patch |git apply --ignore-space-change


1. 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

1. Run the necessary unit tests and cross language test cases to verify the patch

1. Commit the patch

git --config user.name "Your Name"
git --config user.email "[email protected]"
git add -A
git commit
1. The commit message should be in the format:

THRIFT-###:<Jira description>
Client: <component>
Patch: <Name of person contributing the patch>
Description of what was fixed or addressed.
<%
if this is a github pull request then copy the below block
from the GitHub email that came to dev@ list, this will
automatically close the GitHub pull request
%>
Github Pull Request: This closes #XX
----
commit 1234567
Author: docbrown <[email protected]>
Date: 1985-06-03T01:21:00Z

fix for THRIFT-1234

fix for THRIFT-1234 fixes the flux capacitor


1. Double check the patch committed and that nothing was missed then push the patch

git status
git show HEAD
git push origin master

1. Resolve the jira issue and set the following for the changelog

* Component the patch is for
* fixVersion to the current version on master



45 changes: 45 additions & 0 deletions doc/HowToContribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
## How to contribute

1. Make sure your issue is not all ready in the [Jira issue tracker]({{ conf.jira_url }})
1. If not, create a ticket describing the change you're proposing in the [Jira issue tracker]({{ conf.jira_url }})
1. Contribute your patch using one of the two methods below

### Contributing via a patch

1. Check out the latest version of the source code

* git clone https://git-wip-us.apache.org/repos/asf/thrift.git thrift

1. Modify the source to include the improvement/bugfix

* Verify that you follow the same CodingStyle you see within the language you are working on
* Verify that your change works by adding a unit test.

1. Create a patch from project root directory (e.g. you@dev:~/thrift $ ):

* git diff > ../thrift-XXX-my-new-feature.patch

1. Attach the newly generated patch to the issue
1. Wait for other contributors or committers to review your new addition
1. Wait for a committer to commit your patch

### Contributing via GitHub pull requests

1. Create a fork for http://github.com/apache/thrift
1. Create a branch with the jira ticket number you are working on
1. Modify the source to include the improvement/bugfix

* Verify that you follow the same CodingStyle you see within the language you are working on
* Verify that your change works by adding a unit test.

1. Issue a pull request for your new feature
1. Wait for other contributors or committers to review your new addition
1. Wait for a committer to commit your patch

### More info

Plenty of information on why and how to contribute is available on the Apache Software Foundation (ASF) web site. In particular, we recommend the following:

* [Contributors Tech Guide](http://www.apache.org/dev/contributors)
* [Get involved!](http://www.apache.org/foundation/getinvolved.html)
* [Legal aspects on Submission of Contributions (Patches)](http://www.apache.org/licenses/LICENSE-2.0.html#contributions)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 347a5eb

Please sign in to comment.