You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tika.apache.org by ma...@apache.org on 2015/02/25 08:49:20 UTC

svn commit: r1662175 - /tika/trunk/README.md

Author: mattmann
Date: Wed Feb 25 07:49:20 2015
New Revision: 1662175

URL: http://svn.apache.org/r1662175
Log:
instructions for how to contribute via Github. This closes #31.

Modified:
    tika/trunk/README.md

Modified: tika/trunk/README.md
URL: http://svn.apache.org/viewvc/tika/trunk/README.md?rev=1662175&r1=1662174&r2=1662175&view=diff
==============================================================================
--- tika/trunk/README.md (original)
+++ tika/trunk/README.md Wed Feb 25 07:49:20 2015
@@ -17,6 +17,27 @@ Tika is based on Java 6 and uses the [Ma
 The build consists of a number of components, including a standalone runnable jar that you can use to try out Tika features. You can run it like this:
 
     java -jar tika-app/target/tika-app-*.jar --help
+    
+Contributing via Github
+=======================
+To contribute a patch, follow these instructions (note that installing
+[Hub](http://hub.github.com) is not strictly required, but is recommended).
+
+```
+0. Download and install hub.github.com
+1. File JIRA issue for your fix at https://issues.apache.org/jira/browse/TIKA
+- you will get issue id TIKA-xxx where xxx is the issue ID.
+2. git clone http://github.com/apache/tika.git 
+3. cd tika
+4. git checkout -b TIKA-xxx
+5. edit files
+6. git status (make sure it shows what files you expected to edit)
+7. git add <files>
+8. git commit -m “fix for TIKA-xxx contributed by <your username>”
+9. git fork
+10. git push -u <your git username> TIKA-xxx
+11. git pull-request
+```
 
 License (see also LICENSE.txt)
 ------------------------------