Hopiu/wagtail
1
0
Fork 0
mirror of https://github.com/Hopiu/wagtail.git synced 2026-04-15 12:31:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

updated docs

Browse source
This commit is contained in:
Dave Cranwell 2014-06-06 14:37:05 +01:00
parent 4b39b71389
commit 871f4fe37f
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/contributing.rst
View file

@ -17,6 +17,24 @@ Coding guidelines
* PEP8. We ask that all Python contributions adhere to the `PEP8 <http://www.python.org/dev/peps/pep-0008/>`_ style guide, apart from the restriction on line length (E501). The `pep8 tool <http://pep8.readthedocs.org/en/latest/>`_ makes it easy to check your code, e.g. ``pep8 --ignore=E501 your_file.py``.
* Tests. Wagtail has a suite of tests, which we are committed to improving and expanding. We run continuous integration at `travis-ci.org/torchbox/wagtail <https://travis-ci.org/torchbox/wagtail>`_ to ensure that no commits or pull requests introduce test failures. If your contributions add functionality to Wagtail, please include the additional tests to cover it; if your contributions alter existing functionality, please update the relevant tests accordingly.
Styleguide
~~~~~~~~~~
Developers working on the wagtail UI or creating new UI components may wish to test their work against the Styleguide, which is provided as the contrib module "wagtailstyleguide".
To install the styleguide module on your site, add it to the list of ``INSTALLED_APPS`` in your settings:
.. code-block:: python
INSTALLED_APPS = (
...
'wagtail.contrib.wagtailstyleguide',
...
)
At present the styleguide is static: new UI components must be added to it manually, and there are no hooks into it for other modules to use. We hope to support hooks in the future.
Translations
~~~~~~~~~~~~