made difference clearer between coding style and styleguide

pull/1301/head
Dave Cranwell 2015-05-14 14:21:36 +01:00 zatwierdzone przez Karl Hobley
rodzic 66a901c48c
commit 2ab94a0022
2 zmienionych plików z 19 dodań i 10 usunięć

Wyświetl plik

@ -1,5 +1,5 @@
Development process
-------------------
Development
-----------
Using the demo site & Vagrant
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -28,12 +28,22 @@ Uncomment the lines from ``import sys`` onward, and edit the rest of ``local.py`
If your VM is currently running, you'll then need to run ``vagrant halt`` followed by ``vagrant up`` for the changes to take effect.
Unit tests
~~~~~~~~~~
Development dependencies
~~~~~~~~~~~~~~~~~~~~~~~~
Wagtail has extensive tests which should be run before submitting pull requests. To run Wagtail's test suite you will need to install some dependencies. We recommend installing these into a virtual environment.
Developing Wagtail requires additional Python modules for testing and documentation.
**Setting up the virtual environment**
The list of dependencies is in the Wagtail root directory in ``requirements-dev.txt`` and if you've used the Vagrant environment above, can be installed thus, from the Wagtail codebase root directory::
pip install -r requirements-dev.txt
Testing
~~~~~~~
Wagtail has unit tests which should be run before submitting pull requests.
**Testing virtual environment** (skip this if working in Vagrant box)
If you are using Python 3.3 or above, run the following commands in your shell
at the root of the Wagtail repo::
@ -50,8 +60,7 @@ the first line above with:
**Running the tests**
With your virtual environment active, run the following command to run all the
tests::
From the root of the Wagtail codebase, run the following command to run all the tests::
python runtests.py

Wyświetl plik

@ -1,5 +1,5 @@
Styleguide
==========
UI Styleguide
=============
Developers working on the Wagtail UI or creating new UI components may wish to test their work against our Styleguide, which is provided as the contrib module "wagtailstyleguide".