1
1
Contributing
2
2
============
3
3
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
+
4
8
Testing the Library
5
9
-------------------
6
10
@@ -27,7 +31,7 @@ To run the unit tests separately:
27
31
Functional Tests
28
32
~~~~~~~~~~~~~~~~
29
33
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.
31
35
The functional test suite by default uses PHP’s built-in web server. If you have
32
36
PHP 5.4 or newer, simply run with the default configuration.
33
37
@@ -44,8 +48,8 @@ To run the functional tests:
44
48
45
49
$ phpunit tests/Functional
46
50
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 `.
49
53
50
54
To run only the `varnish ` functional tests:
51
55
@@ -58,21 +62,22 @@ For more information about testing, see :doc:`/testing-your-application`.
58
62
Building the Documentation
59
63
--------------------------
60
64
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:
62
67
63
68
.. code-block :: bash
64
69
65
70
$ pip install -r doc/requirements.txt
66
-
71
+
67
72
To build the docs:
68
73
69
74
.. code-block :: bash
70
75
71
76
$ cd doc
72
77
$ make html
78
+ $ make spelling
73
79
74
80
.. _HHVM : http://www.hhvm.com/
75
81
.. _HHVM FastCGI server : https://github.com/facebook/hhvm/wiki/fastcgi
76
82
.. _install Sphinx : http://sphinx-doc.org/latest/install.html
77
-
78
-
83
+ .. _install enchant : http://www.abisource.com/projects/enchant/
0 commit comments