YouCKAN is open-source and very open to contributions.
Issues are contributions in a way so don’t hesitate to submit reports on the official bugtracker.
Provide as much informations as possible to specify the issues:
- the YouCKAN version used
- a stacktrace
- installed applications list
Submitting patches (bugfix, features, ...)¶
If you want to contribute some code:
- fork the official YouCKAN repository
- create a branch with an explicit name (like my-new-feature or issue-XX)
- do your work in it
- rebase it on the master branch from the official repository (cleanup your history by performing an interactive rebase)
- submit your pull-request
There are some rules to follow:
- your contribution should be documented (if needed)
- your contribution should be tested and the test suite should pass successfully
- your code should be mostly PEP8 compatible with a 120 characters line length
- your contribution should support both Python 2 and 3 (use tox to test)
You need to install some dependencies to hack on YouCKAN:
$ pip install -r requirements/all.pip
A fabfile is provided to simplify the common tasks:
To ensure everything is fine before submission, use tox. It will run the test suite on all the supported Python version and ensure the documentation is generating.
You also need to ensure your code is PEP8 compliant (following the project rules: see pep8.rc file):
$ fab pep8
Don’t forget client-side code and tests.
minification use yuglify so you need to install it before: npm install -g yuglify