Development Hints

This page is supposed to give you some information on how to code Adhocracy. Adhocracy is an open-source project, so please feel free to look into the code, explore and fix it.

Checkout

In order to get up and running, execute the InstallationInstructions except for the part where it tells you to download Adhocracy from PyPI. Instead, execute the following commands (inside a virtualenv, if you like):

hg clone https://bitbucket.org/liqd/adhocracy
cd adhocracy 
python setup.py develop

This will check out Adhocracy and install any dependecies. After this, continue to follow the setup guide to create your database and site configuration.

Contribute

With Bitbucket, it is very easy to create a (friendly) fork of Adhocracy's source code to work on freely. If you want your changes to be included in the official source code, just file a push request. Details on forking and push requests can be found at  Bitbucket 101.

In order to get commit access to the main repository (which we hand out very liberally), please write to the adhocracy-dev mailing liste (see below) or introduce yourself on work@ if you're completely new to the group.  FriedrichLindenberg will grant you commit rights on the hg repo ASAP after you do that.

Documentation

There is very little documentation available on the internals of Adhocracy. While any developer should read some of the pages linked from WikiHome?, the REST documentation can probably be considered a more relevant source of information for development purposes. It can be found within the SVN checkout at:

docs/_build/html/index.html

Mailing List

For all personal discussion, the  work mailing list should be used. Another mailing list,  adhocracy-dev is used for commit messages and error reports from the testing system. Please subscribe there if you want to keep in touch with the development internals.