Getting started with the OpenHatch code (moved): Difference between revisions

Content added Content deleted

Inline

Latest revision as of 08:48, 18 February 2014

This is a page about improving or modifying OpenHatch.

We call that "Hacking OpenHatch," and there is a whole category of pages about that.

This page is now included in our project package, and is automatically generated by sphinx at openhatch.readthedocs.org: Getting started with the OpenHatch code

@@ Line 1: / Line 1: @@
 {{Hacking OpenHatch}}
-To get your own instance of OpenHatch running, follow these steps and then get in touch with us.
+This page is now included in our project package, and is automatically generated by sphinx at openhatch.readthedocs.org: [http://openhatch.readthedocs.org/en/latest/getting_started/index.html Getting started with the OpenHatch code]
-The code is written in Python. It uses the Django toolkit and tries to stick to good software testing practices. If you have Python experience, you should be able to get hacking pretty quickly even if you don't know Django or testing.
-== How to run a local site ==
-=== Clone our git repository ===
-You will need to have the ''git'' version control system installed. Once you do, type this into a terminal:
- $ git clone git://gitorious.org/openhatch/oh-mainline.git
-It will take between 7 and 15 minutes. it's kind of a big repository. (Sixty megabytes, or so.)
-=== Read INSTALLATION.mkd inside ===
-Once you have the repository, open up the INSTALLATION.mkd file in any text viewer (like ''gedit' or your favorite web browser).
-Read it, and follow the few short steps to getting your local site going..
-== Next steps ==
-=== Get in touch ===
-We really recommend that you get in touch with us. (It's not quite mandatory, but we'll all be happier if you do)
-# Join the [http://lists.openhatch.org/mailman/listinfo/devel Devel mailing list] and say hello.
-# [[Chat with us on IRC|the #openhatch IRC channel in freenode]].
-#* We have weekly meetings, typically on Saturdays at 4pm EST (-5 UTC).
-=== Read more documentation ===
-Before you start hacking OpenHatch, we strongly advise you to watch [http://python.mirocommunity.org/video/1882/djangocon-2010-learning-a-new- Learning new codebase] talk by Justin Lilly given during [http://python.mirocommunity.org/category/djangocon-2010 DjangoCon 2010].
-You can find more tips about hacking OpenHatch in the [[:Category:Hacking_OpenHatch]]!
-You can find things to work on by browsing our [http://openhatch.org/bugs/ bug tracker] or asking us!
-=== Start contributing patches! ===
-We mark issues that are particularly good for new contributors with the "bitesize" keyword on our bug tracker. You can find the open easy issues [https://openhatch.org/bugs/issue?@columns=title,id,activity,status,assignedto&@sort=activity&@group=priority&@filter=status,keyword&@pagesize=50&@startwith=0&status=-1,1,2,3,4,5,6,7,9,10&keyword=1&@dispname=bitesized here].
-If you find an issue you like and it isn't assigned to anyone, assign it to yourself and start hacking (you'll need an OpenHatch account to log in to the bug tracker). If it is assigned to someone already, but it looks like they haven't gotten around to working on it, leave a note on the ticket saying that you are interested in taking it (you can also try asking on IRC).
-When you are ready to submit a patch for an issue, follow the guidelines at [[How we handle patches]].
-If you ever feel like you are getting stuck or could use some design feedback, don't hesitate to ask for help on the IRC channel, on the devel mailing list, or on the issue ticket. Attending the weekly development meetings on IRC is a great time to ask for help or recommendations on issues to work on.