Get Involved
From OpenCITT
Contents |
Preamble
By submitting any contributions to this project you confirm that you have the copyright for the work you are submitting. The project is licenced under the GNU GPL v2.
Editing the code
Code Conventions: For the project's code to be in a homogen style there are some conventions, developers are asked to respect.
-This project uses the K&R indentation style for all C/C++ Code. Anyway, in the past there was some code written using the BSD/Allman indentation style. Whenever such pieces of code needs to get changed, it's style should be converted to the K&R style. -Class names upper/lowercase style is like "class cAnyClass" -Filenames are lowercase like "canyclass.[h|cpp]"
There are still some older files in trunk that don't match these conventions like "CDisplay.cpp" or "class CDisplay". Feel free to update these.
As most parts of the codebase have undergone huge conceptional changes since the project went open source, the code is in rather bad condition. If you feel thats true, please don't complain. You're welcome to get involed, it would be a perfect getting-started to improve the code.
In order to get your code into svn write a mail with your patch attached to one of the project admins. You will find a list at the sourceforge project page. If you have already sent some patches and are a more experienced openCITT developer you may apply for a developer account with full subversion access.
Editing documentation
If you are not an experienced programmer but still interested in helping this project to improve there is a great opportunity for you. The projects documentation could need a great improvement (there is not very much, yet). This includes documentation to be supplied together with the program, but wiki documentation as well. Any contribution improving the current state of the documentation is very welcome.
To get your documentation contributions into the project either edit the wiki (see below) or send anything you have to one of the project admins. You will find a list at the sourceforge project page.
Editing the wiki
Just create your own openCITT wiki account and feel free to update / extend it appropriately.
