Contributing to the project

This document provides guidelines for people who want to contribute to the project.

Create tickets

Please use the bugtracker [1] before starting some work:

• check if the bug or feature request has already been filed. It may have been answered too!
• else create a new ticket.
• if you plan to contribute, tell us, so that we are given an opportunity to give feedback as soon as possible.
• Then, in your commit messages, reference the ticket with some refs #TICKET-ID syntax.

Fork and branch

• Work in forks and branches.
• Prefix your branch with the ticket ID corresponding to the issue. As an example, if you are working on ticket #23 which is about contribute documentation, name your branch like 23-contribute-doc.
• If you work in a development branch and want to refresh it with changes from master, please rebase [2] or merge-based rebase [3], i.e. don’t merge master.

Setup a development environment

System requirements:

• Python [4] version 2.6 or 2.7, available as python command.

  Note

  You may use Virtualenv [5] 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/django-downloadview.git
cd django-downloadview/
make develop

If you cannot execute the Makefile, read it and adapt the few commands it contains to your needs.

The Makefile

A Makefile is provided to ease development. Use it to:

• setup the development environment: make develop
• update it, as an example, after a pull: make update
• run tests: make test
• build documentation: make documentation

The Makefile is intended to be a live reference for the development environment.

Documentation

Follow style guide for Sphinx-based documentations [6] when editing the documentation.

Test and build

Use the Makefile.

Demo project included

The Demo project is part of the tests. Maintain it along with code and documentation.

References

[1]	https://github.com/benoitbryon/django-downloadview/issues

[2]	http://git-scm.com/book/en/Git-Branching-Rebasing

[3]	http://tech.novapost.fr/psycho-rebasing-en.html

[4]	http://python.org

[5]	http://virtualenv.org

[6]	http://documentation-style-guide-sphinx.readthedocs.org/