Fancy helping out? Fork, commit and issue a pull request :)
I can’t guarantee I will accept your pull request, but here some things which will help:
I use Git Flow to develop this project, as such the branch structure is as follows:
So please create new features from the develop branch. Pull requests onto master directly will not be accepted unless it is a hotfix.
Note
This section assumes familiarity with python virtual environments and virtualenvwrapper.
First create a fork of http://github.com/krak3n/facio so it’s in your own github account, then clone:
$ git clone git@github.com:you/facio.git
Once cloned switch to the develop branch:
$ git fetch --all
$ git checkout develop
Create a python virtual environment:
$ virtualenv facio --no-site-packages
$ workon facio
Now you can install the code as a development egg with the development dependencies, this includes everything you need to run tests and debug code.
$ make develop
Facio and it’s dependencies will now be installed into your virtual environment.
I use Vagrant for development so I have bundled the facio repository with a Vagrantfile.
There are the following dependencies:
Once you have all the dependencies installed it should be a simple case of running vagrant up at the root of the repository. Once it’s finished you should have a development environment with all of the facio dependencies installed into a python virtual environment. All you have to do is run:
$ make develop
On the vagrant box.