This document provides guidelines for people who want to contribute to the wardrobe project.
Please use the bugtracker [1] before starting some work:
System requirements:
Python [2] version 2.6 or 2.7, available as python command.
Note
You may use Virtualenv [3] to make sure the active python is the right one.
make and wget to use the provided Makefile.
Execute:
git clone git@github.com/benoitbryon/wardrobe.git
cd wardrobe/
make develop
If you cannot execute the Makefile, read it and adapt the few commands it contains to your needs.
A Makefile is provided to ease development. Use it to:
The Makefile is intended to be a live reference for the development environment.
Follow style guide for Sphinx-based documentations [4] when editing the documentation.
Tests and builds will automatically be triggered before commit:
If you want to run them manually, use the Makefile.