add HACKING document to the zeitgeist project

Bug #497306 reported by Markus Korn on 2009-12-16
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Zeitgeist Framework
Fix Released
Markus Korn

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 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?

Related branches

Markus Korn (thekorn) on 2009-12-16
Changed in zeitgeist:
importance: Undecided → Wishlist
Siegfried Gevatter (rainct) wrote :

 - Keep lines shorter than 80 characters.
 - Follow everything in PEP-8 except what we don't :P.

- 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

Markus Korn (thekorn) on 2010-01-08
Changed in zeitgeist:
assignee: nobody → Markus Korn (thekorn)
milestone: none → 0.3.1
status: New → In Progress
Changed in zeitgeist:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers