commit 137ddd824694f12686dab3c4c130334653f2c756 Author: Arturo Filastò art@fuffa.org Date: Tue Aug 12 20:07:33 2014 +0200
Add details on how to contribute to the README.md
This closes https://trac.torproject.org/projects/tor/ticket/11980 --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+)
diff --git a/README.md b/README.md index 5f07069..28c895c 100644 --- a/README.md +++ b/README.md @@ -232,3 +232,27 @@ tracker [filing them under the "Ooni" component](https://trac.torproject.org/pro You can either register an account or use the group account "cypherpunks" with password "writecode".
+## Contributing + +You can download the code for ooniprobe from the following git repository: + +``` +git clone https://git.torproject.org/ooni-probe.git +``` + +It is also viewable on the web via [https://gitweb.torproject.org/ooni-probe.git%5D(https://git.torproject.org/o...). + +You should then submit patches for review as pull requests to this github repository: + +https://github.com/TheTorProject/ooni-probe + +Read this article to learn how to [create a pull request on github](https://help.github.com/articles/creating-a-pull-request). + +If you prefer not to use github (or don't have an account), you may also submit +patches as attachments to tickets. + +Be sure to format the patch (given that you are working on a feature branch that is different from master) with: + +``` +git format-patch master --stdout > my_first_ooniprobe.patch +```