summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorKonrad Grochowski <hcorg@apache.org>2015-02-04 16:43:26 +0100
committerKonrad Grochowski <hcorg@apache.org>2015-02-05 12:15:19 +0100
commit3bc6424c76c1c29da72fe16ad9d3014b09b02b0f (patch)
tree6daa184c23c2e30df4044c5b2966befdcdb378bf /CONTRIBUTING.md
parent2f34da70243675c4d8e04f368522046fe99dcb50 (diff)
downloadthrift-3bc6424c76c1c29da72fe16ad9d3014b09b02b0f.tar.gz
THRIFT-2724 - Coding standards template added all over project
Client: All Patch: Konrad Grochowski This closes #371
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md37
1 files changed, 20 insertions, 17 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f3074a4cc..a569fd729 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -3,43 +3,46 @@
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
+
+ * 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.
+
+ * Remember to provide *tests* for all submited changes
+ * When bugfixing: add test that will isolate bug *before* applying change that fixes it
+ * Verify that you follow [Thrift Coding Standards](/coding_standards) (you can run 'make style', which ensures proper format for some languages)
1. Create a patch from project root directory (e.g. you@dev:~/thrift $ ):
-
- * git diff > ../thrift-XXX-my-new-feature.patch
+
+ * 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. Create a branch for your changes
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
+ * Remember to provide *tests* for all submited changes
+ * When bugfixing: add test that will isolate bug *before* applying change that fixes it
+ * Verify that you follow [Thrift Coding Standards](/coding_standards) (you can run 'make style', which ensures proper format for some languages)
+
+1. Commit and push changes to your branch
+1. Issue a pull request with the jira ticket number you are working on in it's name
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)