zeitgeist team mailing list archive

[Mikkel Kamstrup Erlandsen <mikkel.kamstrup@xxxxxxxxx>]

- TABs for indentation
- All code in zeitgeist.* is our public API and *must* be fully documented
- Code in _zeitgeist is private code and should be documented and written in a way so that others can understand it

-- 
add HACKING document to the zeitgeist project
https://bugs.launchpad.net/bugs/497306
You received this bug notification because you are a member of Zeitgeist
Developers, which is the registrant for Zeitgeist Framework.

Status in Zeitgeist Framework: New

Bug description:
To define some principles for existing and hopefully at some point new contributors it would be cool to have a HACKING document.
Let's use this bugreport to collect a few things which should be mentioned there:

 * python version: zeitgeist is developed to be usable with python >= 2.5
 * code review: bigger changes should be reviewed by at least one member of the launchpad.net/~zeitgeist team
 * changes to the public API are only possible major release series
 * doc- or unitests should be written for significant changes to the code, the testsuite should be run before commits to make sure everything works fine
 * code should be documented as much as possible

does this make sense?
any thoughts or additional things we should mention?