Contributing

Jump to bottom Edit New page

aliceh75 edited this page Sep 30, 2014 · 2 revisions

Contributing

We welcome pull requests; please take a moment to go through our code and style guide. Note that not all existing code follows these; however all new code should.

Style & Code Guide

Follow PEP8 in all things;
Use NumPy docstrings for documentation;
Start private attributes and methods with an underscore;
Avoid public attributes on classes that contain application logic, use accessors/settors instead. Classes that are mostly containers may use public attributes.