Coding Guidelines

MV3D uses Twisted's coding standard for all code.

Unit Tests

All code submissions should have good unit test coverage. A basic example of how to write a unit test can be found in the Python manual. Before any code can be submitted to trunk, all unit tests must pass. The unit tests can be run via the command trial mv3d.test. On Windows, this should be run from a Divmod / Twisted command shell. Unit tests on multiple platforms can be run via the Hudson builder. For access, please contact SirGolan.

Docstrings

All classes and public methods or functions should have docstrings that are written in full sentences.

Portability

Code must run on all supported platforms (when submitting to trunk, unit tests will run on multiple platforms).