You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@thrift.apache.org by jf...@apache.org on 2014/04/01 03:19:11 UTC

svn commit: r1583503 - in /thrift/cms-site/trunk: content/about.md content/docs/HowToContribute.md content/docs/committers/HowToCommit.md lib/path.pm

Author: jfarrell
Date: Tue Apr  1 01:19:11 2014
New Revision: 1583503

URL: http://svn.apache.org/r1583503
Log:
updating how to contribute and adding how to commit docs

Added:
    thrift/cms-site/trunk/content/docs/committers/HowToCommit.md
Modified:
    thrift/cms-site/trunk/content/about.md
    thrift/cms-site/trunk/content/docs/HowToContribute.md
    thrift/cms-site/trunk/lib/path.pm

Modified: thrift/cms-site/trunk/content/about.md
URL: http://svn.apache.org/viewvc/thrift/cms-site/trunk/content/about.md?rev=1583503&r1=1583502&r2=1583503&view=diff
==============================================================================
--- thrift/cms-site/trunk/content/about.md (original)
+++ thrift/cms-site/trunk/content/about.md Tue Apr  1 01:19:11 2014
@@ -76,13 +76,3 @@ The following companies are known to emp
     </table>
 </div>
 
-----
-
-###Testimonials
-
-{% for item in conf.testimonials %}
-> {{ item.0  }}
-
-[{{ item.1 }}]({{ item.2 }})
-{% endfor %}
-

Modified: thrift/cms-site/trunk/content/docs/HowToContribute.md
URL: http://svn.apache.org/viewvc/thrift/cms-site/trunk/content/docs/HowToContribute.md?rev=1583503&r1=1583502&r2=1583503&view=diff
==============================================================================
--- thrift/cms-site/trunk/content/docs/HowToContribute.md (original)
+++ thrift/cms-site/trunk/content/docs/HowToContribute.md Tue Apr  1 01:19:11 2014
@@ -5,22 +5,44 @@ kind: doc
 ## 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 issue tracker
- 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 developers or committers to review it and hopefully +1 the ticket
- 1. Wait for a committer to commit it.
+ 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:
+ 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)

Added: thrift/cms-site/trunk/content/docs/committers/HowToCommit.md
URL: http://svn.apache.org/viewvc/thrift/cms-site/trunk/content/docs/committers/HowToCommit.md?rev=1583503&view=auto
==============================================================================
--- thrift/cms-site/trunk/content/docs/committers/HowToCommit.md (added)
+++ thrift/cms-site/trunk/content/docs/committers/HowToCommit.md Tue Apr  1 01:19:11 2014
@@ -0,0 +1,71 @@
+---
+title: "How To Commit"
+kind: doc
+---
+## How to Commit
+
+ 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 "YourApacheID@apache.org"
+		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 <do...@example.com>
+		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
+	
+
+ 
\ No newline at end of file

Modified: thrift/cms-site/trunk/lib/path.pm
URL: http://svn.apache.org/viewvc/thrift/cms-site/trunk/lib/path.pm?rev=1583503&r1=1583502&r2=1583503&view=diff
==============================================================================
--- thrift/cms-site/trunk/lib/path.pm (original)
+++ thrift/cms-site/trunk/lib/path.pm Tue Apr  1 01:19:11 2014
@@ -124,15 +124,6 @@ powered_by: [
         [ "Aereo", "http://www.aereo.com" ]
     ]
 
-# testimonials: Text, Author, Link
-testimonials: [
-        [ "As I have said to a number of people, Thrift is the Swiss Army Knife of software.",
-          "Rush Manbert",
-          "http://mail-archives.apache.org/mod_mbox/thrift-user/201401.mbox/%3cA9426854-4369-4D29-8E1D-7328904981A6@manbert.com%3e"
-          ]
-    ]
-
-
 # Item, Automated via configure, Location of versioning file
 versioning: [
         [ "thrift-compiler", "yes", "configure.ac" ],