2014-04-05 16:20:07 +00:00
## How to contribute
2015-04-07 21:05:31 +00:00
1. Help to review and verify existing patches
2014-10-02 15:25:47 +00:00
1. Make sure your issue is not all ready in the [Jira issue tracker ](http://issues.apache.org/jira/browse/THRIFT )
1. If not, create a ticket describing the change you're proposing in the [Jira issue tracker ](http://issues.apache.org/jira/browse/THRIFT )
2014-04-05 16:20:07 +00:00
1. Contribute your patch using one of the two methods below
2015-02-04 15:43:26 +00:00
2014-04-05 16:20:07 +00:00
### Contributing via a patch
2015-02-04 15:43:26 +00:00
2014-04-05 16:20:07 +00:00
1. Check out the latest version of the source code
2015-02-04 15:43:26 +00:00
* git clone https://git-wip-us.apache.org/repos/asf/thrift.git thrift
2014-04-05 16:20:07 +00:00
1. Modify the source to include the improvement/bugfix
2015-02-04 15:43:26 +00:00
* Remember to provide *tests* for all submited changes
* When bugfixing: add test that will isolate bug *before* applying change that fixes it
2015-10-05 19:24:44 +00:00
* Verify that you follow [Thrift Coding Standards ](/docs/coding_standards.md ) (you can run 'make style', which ensures proper format for some languages)
2014-04-05 16:20:07 +00:00
1. Create a patch from project root directory (e.g. you@dev:~/thrift $ ):
2015-02-04 15:43:26 +00:00
* git diff > ../thrift-XXX-my-new-feature.patch
2014-04-05 16:20:07 +00:00
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
2015-02-04 15:43:26 +00:00
2014-04-05 16:20:07 +00:00
### Contributing via GitHub pull requests
1. Create a fork for http://github.com/apache/thrift
2015-04-07 21:05:31 +00:00
1. Create a branch for your changes(best practice is issue as branch name, e.g. THRIFT-9999)
2014-04-05 16:20:07 +00:00
1. Modify the source to include the improvement/bugfix
2015-02-04 15:43:26 +00:00
* Remember to provide *tests* for all submited changes
* When bugfixing: add test that will isolate bug *before* applying change that fixes it
2015-10-05 19:24:44 +00:00
* Verify that you follow [Thrift Coding Standards ](/docs/coding_standards.md ) (you can run 'make style', which ensures proper format for some languages)
2015-05-01 04:03:19 +00:00
* Verify that your change works on other platforms by adding a GitHub service hook to [Travis CI ](http://docs.travis-ci.com/user/getting-started/#Step-one%3A-Sign-in ) and [AppVeyor ](http://www.appveyor.com/docs )
2015-02-04 15:43:26 +00:00
2015-04-07 21:05:31 +00:00
1. Commit and push changes to your branch (please use issue name and description as commit title, e.g. THRIFT-9999 make it perfect)
2015-02-04 15:43:26 +00:00
1. Issue a pull request with the jira ticket number you are working on in it's name
2014-04-05 16:20:07 +00:00
1. Wait for other contributors or committers to review your new addition
1. Wait for a committer to commit your patch
### More info
2015-02-04 15:43:26 +00:00
2014-04-05 16:20:07 +00:00
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:
2015-02-04 15:43:26 +00:00
2014-04-05 16:20:07 +00:00
* [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 )