pelican-theme/docs/contribute.rst

How to contribute?
###################
There are many ways to contribute to Pelican. You can enhance the
documentation, add missing features, and fix bugs (or just report them).

Don't hesitate to fork and make a pull request on GitHub.

Setting up the development environment
======================================

You're free to set up your development environment any way you like. Here is a
way using virtualenv and virtualenvwrapper. If you don't have them, you can
install these packages via::

    $ pip install virtualenvwrapper

Virtual environments allow you to work on Python projects which are isolated
from one another so you can use different packages (and package versions) with
different projects.

To create a virtual environment, use the following syntax::

    $ mkvirtualenv pelican 

To manually install the dependencies::

    $ pip install -r dev_requirements.txt
    $ python setup.py develop

Running the test suite
======================

Each time you add a feature, there are two things to do regarding tests:
checking that the existing tests pass, and adding tests for your new feature
or for the bug you're fixing.

The tests live in "pelican/tests" and you can run them using the
"discover" feature of unittest2::

    $ unit2 discover

If you have made changes that affect the output of a pelican generated weblog,
then you should update the output used by functional tests.
To do so, you can use the 2 following commands::

    $ LC_ALL="C" pelican -o tests/output/custom/ -s samples/pelican.conf.py \
        samples/content/
    $ LC_ALL="C" USER="Dummy Author" pelican -o tests/output/basic/ samples/content/

Coding standards
================

Try to respect what is described in the PEP8
(http://www.python.org/dev/peps/pep-0008/) when providing patches. This can be
eased by the pep8 tool (http://pypi.python.org/pypi/pep8) or by Flake8, which
will give you some other cool hints about what's good or wrong
(http://pypi.python.org/pypi/flake8/)