diff options
| author | Roger Meier <roger@apache.org> | 2014-12-02 00:20:25 +0100 |
|---|---|---|
| committer | Roger Meier <roger@apache.org> | 2014-12-07 14:02:45 +0100 |
| commit | 71067a80908af91e73aac5dc31d672f13085dabd (patch) | |
| tree | e769b71394b8e534feade7fbf532140615c62ba6 /CONTRIBUTING.md | |
| parent | 0494987fd16f4892dbca9c6a22aa5af0e5b20fc5 (diff) | |
| download | thrift-71067a80908af91e73aac5dc31d672f13085dabd.tar.gz | |
THRIFT-2855 Move contributing.md to the root of the repository
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..f3074a4cc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,45 @@ +## How to contribute + + 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) + 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) |