Delorean is currently in active development and welcomes code improvements and bug fixes. For those of your interested in providing documentation to the lesser know parts would be equally awesome!
Pull down the source:
$ git clone email@example.com:myusuf3/delorean.git
All code contributions should have adequate tests. Delorean has high test coverage we would like to keep this way. We provide an easy way to use make command that will run all tests with nose and coverage. Simply run the following command from the root directory:
$ make test
If you decide to contribute code please follow naming conventions and style guides the code currently complies too.
When in doubt, be safe, follow PEP-8.
Contributing to documentation is as simple as editing the specified file in the docs directory of the source. We welcome all code improvements.
We use Sphinx for building our documentation. That can be obtained here .
We provide easy to use make command that will build the docs and open a copy locally in your browser. Simply run the following command from the root directory:
$ make doc