11Contributing
22============
33
4+ We are happy for contributions. Before you invest a lot of time however, best
5+ open an issue on github to discuss your idea. Then we can coordinate efforts
6+ if somebody is already working on the same thing.
7+
48Testing the Library
59-------------------
610
@@ -27,7 +31,7 @@ To run the unit tests separately:
2731 Functional Tests
2832~~~~~~~~~~~~~~~~
2933
30- The library also includes functional tests against a Varnish and NGINX instance.
34+ The library also includes functional tests against a Varnish and NGINX instance.
3135The functional test suite by default uses PHP’s built-in web server. If you have
3236PHP 5.4 or newer, simply run with the default configuration.
3337
@@ -44,8 +48,8 @@ To run the functional tests:
4448
4549 $ phpunit tests/Functional
4650
47- Tests are organized in groups: one for each reverse proxy supported. At the moment
48- groups are: `varnish ` and `nginx `.
51+ Tests are organized in groups: one for each reverse proxy supported. At the moment
52+ groups are: `varnish ` and `nginx `.
4953
5054To run only the `varnish ` functional tests:
5155
@@ -58,21 +62,22 @@ For more information about testing, see :doc:`/testing-your-application`.
5862Building the Documentation
5963--------------------------
6064
61- First `install Sphinx `_, then download the requirements:
65+ First `install Sphinx `_ and `install enchant `_ (e.g. ``sudo apt-get install enchant ``),
66+ then download the requirements:
6267
6368.. code-block :: bash
6469
6570 $ pip install -r doc/requirements.txt
66-
71+
6772 To build the docs:
6873
6974.. code-block :: bash
7075
7176 $ cd doc
7277 $ make html
78+ $ make spelling
7379
7480 .. _HHVM : http://www.hhvm.com/
7581.. _HHVM FastCGI server : https://github.com/facebook/hhvm/wiki/fastcgi
7682.. _install Sphinx : http://sphinx-doc.org/latest/install.html
77-
78-
83+ .. _install enchant : http://www.abisource.com/projects/enchant/
0 commit comments