Source

django-formrenderingtools / docs / contribute.txt

Full commit
#######################
Contribution guidelines
#######################


*****************************
Get a development environment
*****************************

.. code-block:: bash

  # Get the source.
  hg clone http://bitbucket.org/benoitbryon/django-formrenderingtools
  cd django-formrenderingtools/
  # Install.
  make develop
  # You can run the tests!
  make test

If everything went fine, you have a everything you need in the folder. Have a
look at the provided :file:`Makefile` for details.

If a proble occurred, look at the provided :file:`Makefile`. It is the live
install-for-development documentation.


**********
Guidelines
**********

* Create issues, preferably before starting to hack, so that we can discuss as
  soon as possible.
* Work in branches, ideally one branch per issue.
* Write tests and run them with ``make test``.
* Write documentation in :file:`docs/`. Build it with ``make documentation``.
* Update the demo project in :file:`demo/`.