Writing Rules

/!\ this is a first draft
Back

We'll try to write "clean" code. It was not the case at the beginning, but things change. Any help to enhance the code, to make it cleaner and easier to read, is welcome.

We try to follow these rules :

• All the code should be written in python to avoid complexity and dependencies. There may be exceptions for some parts (like the gui)

• The code have to be modular and object-oriented to give the maximal flexibility to reuse each component

• Everything has to be documented. First, all classes, functions etc. have to be commented for Doxygen, as soon as they are created. And sometimes some complicated algorithms need long explanations : no problem, write as long as necessary.

• The PEP 8 Style Guide for Python should be a reference