Skip to content

Commit 4f562f3

Browse files
committed
instructions for how to contribute via Github. This closes apache#31.
git-svn-id: https://svn.apache.org/repos/asf/tika/trunk@1662175 13f79535-47bb-0310-9956-ffa450edef68
1 parent de5df17 commit 4f562f3

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

+21
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,27 @@ Tika is based on Java 6 and uses the [Maven 3](http://maven.apache.org) build sy
1717
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:
1818

1919
java -jar tika-app/target/tika-app-*.jar --help
20+
21+
Contributing via Github
22+
=======================
23+
To contribute a patch, follow these instructions (note that installing
24+
[Hub](http://hub.github.com) is not strictly required, but is recommended).
25+
26+
```
27+
0. Download and install hub.github.com
28+
1. File JIRA issue for your fix at https://issues.apache.org/jira/browse/TIKA
29+
- you will get issue id TIKA-xxx where xxx is the issue ID.
30+
2. git clone http://github.com/apache/tika.git
31+
3. cd tika
32+
4. git checkout -b TIKA-xxx
33+
5. edit files
34+
6. git status (make sure it shows what files you expected to edit)
35+
7. git add <files>
36+
8. git commit -m “fix for TIKA-xxx contributed by <your username>”
37+
9. git fork
38+
10. git push -u <your git username> TIKA-xxx
39+
11. git pull-request
40+
```
2041

2142
License (see also LICENSE.txt)
2243
------------------------------

0 commit comments

Comments
 (0)