Repository: thrift Updated Branches: refs/heads/master 347a5ebb2 -> bb2d2fbf6
THRIFT-2450:include HowToContribute in the src repo Client: build Patch: jfarrell Renamed doc files. Project: http://git-wip-us.apache.org/repos/asf/thrift/repo Commit: http://git-wip-us.apache.org/repos/asf/thrift/commit/bb2d2fbf Tree: http://git-wip-us.apache.org/repos/asf/thrift/tree/bb2d2fbf Diff: http://git-wip-us.apache.org/repos/asf/thrift/diff/bb2d2fbf Branch: refs/heads/master Commit: bb2d2fbf63cac4d2eb46c73d1f3e5c8ceeba5d1e Parents: 347a5eb Author: jfarrell <[email protected]> Authored: Sat Apr 5 12:25:07 2014 -0400 Committer: jfarrell <[email protected]> Committed: Sat Apr 5 12:25:07 2014 -0400 ---------------------------------------------------------------------- doc/HowToCommit.md | 67 --------------------------------------------- doc/HowToContribute.md | 45 ------------------------------ doc/committers.md | 67 +++++++++++++++++++++++++++++++++++++++++++++ doc/contributing.md | 45 ++++++++++++++++++++++++++++++ 4 files changed, 112 insertions(+), 112 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/thrift/blob/bb2d2fbf/doc/HowToCommit.md ---------------------------------------------------------------------- diff --git a/doc/HowToCommit.md b/doc/HowToCommit.md deleted file mode 100644 index 4606da5..0000000 --- a/doc/HowToCommit.md +++ /dev/null @@ -1,67 +0,0 @@ -## 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 - - - http://git-wip-us.apache.org/repos/asf/thrift/blob/bb2d2fbf/doc/HowToContribute.md ---------------------------------------------------------------------- diff --git a/doc/HowToContribute.md b/doc/HowToContribute.md deleted file mode 100644 index 3b538a2..0000000 --- a/doc/HowToContribute.md +++ /dev/null @@ -1,45 +0,0 @@ -## 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) http://git-wip-us.apache.org/repos/asf/thrift/blob/bb2d2fbf/doc/committers.md ---------------------------------------------------------------------- diff --git a/doc/committers.md b/doc/committers.md new file mode 100644 index 0000000..4606da5 --- /dev/null +++ b/doc/committers.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/<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 + + + http://git-wip-us.apache.org/repos/asf/thrift/blob/bb2d2fbf/doc/contributing.md ---------------------------------------------------------------------- diff --git a/doc/contributing.md b/doc/contributing.md new file mode 100644 index 0000000..3b538a2 --- /dev/null +++ b/doc/contributing.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)
