Development rules¶
This document describes coding requirements and conventions for working with the CSjark code base. Please read it carefully and ask back any questions you might have.
Coding Style Standard¶
The programming language used to implement the utility is Python. All the code should as much as possible follow the coding style described in the Style Guide for Python Code (PEP8). In addition we decided that the design should attempt to be pythonic, as detailed by PEP20.
Code base¶
The entire CSjark project is hosted on GitHub. In order to get the source code, you can:
- clone the Git repository: https://github.com/eventh/kpro9
- download most recent tar archive
- download most recent zip archive
Note
When commiting to the repository, always write good log messages. It will help people that will read the diffs in the future.
Issue tracking¶
For issue tracking, we use bug tracking capabilities of GitHub. You can register bugs, discuss issues or see what’s going on for the next milestone, both from an email and from a web interface.