From 871f4fe37f7a004dd735ae4d6be5887ea7811bc6 Mon Sep 17 00:00:00 2001 From: Dave Cranwell Date: Fri, 6 Jun 2014 14:37:05 +0100 Subject: [PATCH] updated docs --- docs/contributing.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/contributing.rst b/docs/contributing.rst index feb3b96f8..8796fbca8 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -17,6 +17,24 @@ Coding guidelines * PEP8. We ask that all Python contributions adhere to the `PEP8 `_ style guide, apart from the restriction on line length (E501). The `pep8 tool `_ 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 `_ 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 ~~~~~~~~~~~~