From 347a5ebb2d16c52e523e4b1b96ce804ef18585f2 Mon Sep 17 00:00:00 2001 From: jfarrell Date: Sat, 5 Apr 2014 12:20:07 -0400 Subject: [PATCH] THRIFT-2450 - include HowToContribute in the src repo Client: build Patch: jfarrell Reorganized docs and adds HowToContribute to the code base. --- doc/HowToCommit.md | 67 +++++++++++++++++++ doc/HowToContribute.md | 45 +++++++++++++ doc/{ => licenses}/lgpl-2.1.txt | 0 doc/{ => licenses}/otp-base-license.txt | 0 .../thrift-protocol-spec.md} | 0 doc/{ => specs}/thrift-sasl-spec.txt | 0 doc/{ => specs}/thrift.tex | 0 7 files changed, 112 insertions(+) create mode 100644 doc/HowToCommit.md create mode 100644 doc/HowToContribute.md rename doc/{ => licenses}/lgpl-2.1.txt (100%) rename doc/{ => licenses}/otp-base-license.txt (100%) rename doc/{thrift.bnf => specs/thrift-protocol-spec.md} (100%) rename doc/{ => specs}/thrift-sasl-spec.txt (100%) rename doc/{ => specs}/thrift.tex (100%) diff --git a/doc/HowToCommit.md b/doc/HowToCommit.md new file mode 100644 index 00000000000..4606da5f19e --- /dev/null +++ b/doc/HowToCommit.md @@ -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//thrift/commit/.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 "YourApacheID@apache.org" + git add -A + git commit + + +1. The commit message should be in the format: + + THRIFT-###: + Client: + 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 + 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 + + + diff --git a/doc/HowToContribute.md b/doc/HowToContribute.md new file mode 100644 index 00000000000..3b538a29d28 --- /dev/null +++ b/doc/HowToContribute.md @@ -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) diff --git a/doc/lgpl-2.1.txt b/doc/licenses/lgpl-2.1.txt similarity index 100% rename from doc/lgpl-2.1.txt rename to doc/licenses/lgpl-2.1.txt diff --git a/doc/otp-base-license.txt b/doc/licenses/otp-base-license.txt similarity index 100% rename from doc/otp-base-license.txt rename to doc/licenses/otp-base-license.txt diff --git a/doc/thrift.bnf b/doc/specs/thrift-protocol-spec.md similarity index 100% rename from doc/thrift.bnf rename to doc/specs/thrift-protocol-spec.md diff --git a/doc/thrift-sasl-spec.txt b/doc/specs/thrift-sasl-spec.txt similarity index 100% rename from doc/thrift-sasl-spec.txt rename to doc/specs/thrift-sasl-spec.txt diff --git a/doc/thrift.tex b/doc/specs/thrift.tex similarity index 100% rename from doc/thrift.tex rename to doc/specs/thrift.tex