Skip to content
This repository
Browse code

Extract information on how to contribute into separate document.

  • Loading branch information...
commit f634bc1e6c2809f2dbf60eb7e3f90f89a9183561 1 parent 65914b0
Sebastian Bergmann authored September 17, 2012
55  CONTRIBUTING.md
Source Rendered
... ...
@@ -0,0 +1,55 @@
  1
+Contributing to PHPUnit
  2
+=======================
  3
+
  4
+Contributions to PHPUnit, its related modules, and its documentation are always welcome. You make our lifes easier by sending us your contributions through GitHub pull requests.
  5
+
  6
+Please note that the `3.6.` branch is closed for features and that pull requests should to be based on `master` or the `3.7.` once it exists.
  7
+
  8
+We are trying to keep backwards compatibility breaks in PHPUnit 3.7 to an absolute minimum so please take this into account when proposing changes.
  9
+
  10
+Due to time constraints, we are not always able to respond as quickly as we would like. Please do not take delays personal and feel free to remind us here or on IRC if you feel that we forgot to respond.
  11
+
  12
+Using PHPUnit From a Git Checkout
  13
+---------------------------------
  14
+
  15
+The following commands can be used to perform the initial checkout of PHPUnit and its dependencies from Git:
  16
+
  17
+    mkdir phpunit && cd phpunit
  18
+    git clone git://github.com/sebastianbergmann/phpunit.git
  19
+    git clone git://github.com/sebastianbergmann/dbunit.git
  20
+    git clone git://github.com/sebastianbergmann/php-file-iterator.git
  21
+    git clone git://github.com/sebastianbergmann/php-text-template.git
  22
+    git clone git://github.com/sebastianbergmann/php-code-coverage.git
  23
+    git clone git://github.com/sebastianbergmann/php-token-stream.git
  24
+    git clone git://github.com/sebastianbergmann/php-timer.git
  25
+    git clone git://github.com/sebastianbergmann/phpunit-mock-objects.git
  26
+    git clone git://github.com/sebastianbergmann/phpunit-selenium.git
  27
+    git clone git://github.com/sebastianbergmann/phpunit-story.git
  28
+    git clone git://github.com/sebastianbergmann/php-invoker.git
  29
+
  30
+The `dbunit`, `php-code-coverage`, `php-file-iterator`, `php-text-template`, `php-timer`, `php-token-stream`, `phpunit`, `phpunit-mock-objects`, `phpunit-selenium`, `phpunit-story`, and `php-invoker` directories need to be added to the `include_path`.
  31
+
  32
+In addition to the checkouts listed above, the YAML component that is provided by the Symfony project is required:
  33
+
  34
+    pear install pear.symfony.com/Yaml
  35
+
  36
+The `phpunit/phpunit.php` script can be used to invoke the PHPUnit test runner.
  37
+
  38
+Running the test suite(s)
  39
+-------------------------
  40
+
  41
+It is not possible to use a system-wide installed version of PHPUnit to run the test suite of a Git checkout. Because of that is is necessary to change the `include_paths` as described below.
  42
+
  43
+This can be achieved with a small wrapper script designed to work with every module in the PHPUnit stack.
  44
+
  45
+Note that you might have to change the path to your PEAR installation here pointing to `/usr/local/lib/php`. You can find it using `pear config-show | grep php_dir`.
  46
+
  47
+### Linux / MacOS X
  48
+
  49
+    #!/bin/bash
  50
+    php -d include_path='.:../phpunit/:../dbunit/:../php-code-coverage/:../php-file-iterator/:../php-invoker/:../php-text-template/:../php-timer:../php-token-stream:../phpunit-mock-objects/:../phpunit-selenium/:../phpunit-story/:/usr/local/lib/php' ../phpunit/phpunit.php $*
  51
+
  52
+### Windows
  53
+
  54
+    @echo off
  55
+    php -d include_path='.;../phpunit/;../dbunit/;../php-code-coverage/;../php-file-iterator/;../php-invoker/;../php-text-template/;../php-timer;../php-token-stream;../phpunit-mock-objects/;../phpunit-selenium/;../phpunit-story/;C:/Program Files/PHP/pear' ../phpunit/phpunit.php %*
0  ChangeLog.markdown → ChangeLog.md
Source Rendered
File renamed without changes
121  README.markdown
Source Rendered
... ...
@@ -1,121 +0,0 @@
1  
-PHPUnit
2  
-=======
3  
-
4  
-PHPUnit is the de-facto standard for unit testing in PHP projects. It provides both a framework that makes the writing of tests easy as well as the functionality to easily run the tests and analyse their results.
5  
-
6  
-Requirements
7  
-------------
8  
-
9  
-* PHPUnit 3.7 requires PHP 5.3.3 (or later) but PHP 5.4.6 (or later) is highly recommended.
10  
-* [PHP_CodeCoverage](http://github.com/sebastianbergmann/php-code-coverage), the library that is used by PHPUnit to collect and process code coverage information, depends on [Xdebug](http://xdebug.org/) 2.0.5 (or later) but Xdebug 2.2.1 (or later) is highly recommended.
11  
-
12  
-Installation
13  
-------------
14  
-
15  
-PHPUnit should be installed using the PEAR Installer, the backbone of the [PHP Extension and Application Repository](http://pear.php.net/) that provides a distribution system for PHP packages.
16  
-
17  
-Depending on your OS distribution and/or your PHP environment, you may need to install PEAR or update your existing PEAR installation before you can proceed with the following instructions. `sudo pear upgrade PEAR` usually suffices to upgrade an existing PEAR installation. The [PEAR Manual ](http://pear.php.net/manual/en/installation.getting.php) explains how to perform a fresh installation of PEAR.
18  
-
19  
-The following two commands (which you may have to run as `root`) are all that is required to install PHPUnit using the PEAR Installer:
20  
-
21  
-    pear config-set auto_discover 1
22  
-    pear install pear.phpunit.de/PHPUnit
23  
-
24  
-After the installation you can find the PHPUnit source files inside your local PEAR directory; the path is usually `/usr/lib/php/PHPUnit`.
25  
-
26  
-Documentation
27  
--------------
28  
-
29  
-The documentation for PHPUnit is available in different formats:
30  
-
31  
-* [English, multiple HTML files](http://www.phpunit.de/manual/3.7/en/index.html)
32  
-* [English, single HTML file](http://www.phpunit.de/manual/3.7/en/phpunit-book.html)
33  
-* [English, PDF](http://www.phpunit.de/manual/3.7/en/phpunit-book.pdf)
34  
-* [English, ePub](http://www.phpunit.de/manual/3.7/en/phpunit-book.epub)
35  
-* [French, multiple HTML files](http://www.phpunit.de/manual/3.7/fr/index.html)
36  
-* [French, single HTML file](http://www.phpunit.de/manual/3.7/fr/phpunit-book.html)
37  
-* [French, PDF](http://www.phpunit.de/manual/3.7/fr/phpunit-book.pdf)
38  
-* [French, ePub](http://www.phpunit.de/manual/3.7/fr/phpunit-book.epub)
39  
-* [Japanese, multiple HTML files](http://www.phpunit.de/manual/3.7/ja/index.html)
40  
-* [Japanese, single HTML file](http://www.phpunit.de/manual/3.7/ja/phpunit-book.html)
41  
-* [Japanese, PDF](http://www.phpunit.de/manual/3.7/ja/phpunit-book.pdf)
42  
-* [Japanese, ePub](http://www.phpunit.de/manual/3.7/ja/phpunit-book.epub)
43  
-
44  
-IRC
45  
----
46  
-
47  
-The [#phpunit channel on the Freenode IRC network](irc://freenode.net/phpunit) is a place to chat about PHPUnit.
48  
-
49  
-Using PHPUnit From a Git Checkout
50  
----------------------------------
51  
-
52  
-The following commands can be used to perform the initial checkout of PHPUnit and its dependencies from Git:
53  
-
54  
-    mkdir phpunit && cd phpunit
55  
-    git clone git://github.com/sebastianbergmann/phpunit.git
56  
-    git clone git://github.com/sebastianbergmann/dbunit.git
57  
-    git clone git://github.com/sebastianbergmann/php-file-iterator.git
58  
-    git clone git://github.com/sebastianbergmann/php-text-template.git
59  
-    git clone git://github.com/sebastianbergmann/php-code-coverage.git
60  
-    git clone git://github.com/sebastianbergmann/php-token-stream.git
61  
-    git clone git://github.com/sebastianbergmann/php-timer.git
62  
-    git clone git://github.com/sebastianbergmann/phpunit-mock-objects.git
63  
-    git clone git://github.com/sebastianbergmann/phpunit-selenium.git
64  
-    git clone git://github.com/sebastianbergmann/phpunit-story.git
65  
-    git clone git://github.com/sebastianbergmann/php-invoker.git
66  
-
67  
-The `dbunit`, `php-code-coverage`, `php-file-iterator`, `php-text-template`, `php-timer`, `php-token-stream`, `phpunit`, `phpunit-mock-objects`, `phpunit-selenium`, `phpunit-story`, and `php-invoker` directories need to be added to the `include_path`.
68  
-
69  
-In addition to the checkouts listed above, the YAML component that is provided by the Symfony project is required:
70  
-
71  
-    pear install pear.symfony.com/Yaml
72  
-
73  
-The `phpunit/phpunit.php` script can be used to invoke the PHPUnit test runner.
74  
-
75  
-Contributing
76  
-------------
77  
-
78  
-Contributions to PHPUnit, its related modules and its documentation are always welcome and best done using GitHub pull request.
79  
-
80  
-Please note that the `3.6.` branch is closed for features and that pull requests should to be based on `master` or the `3.7.` once it exists. 
81  
-
82  
-We are trying to keep BC breaks in PHPUnit 3.7 to a absolute minimum so please take this into account when proposing changes.
83  
-
84  
-Due to time constraints we are not always able to respond as quickly as we'd like to so please do not take delays personal and feel free to remind us here or on IRC if you feel that we forgot to respond.
85  
-
86  
-### List of Contributors
87  
-
88  
-Thanks to everyone that has contributed to PHPUnit! You can find a detailed contributors list on every PHPUnit related package on GitHub. This list shows only the bigger components:
89  
-
90  
-- [PHPUnit core](https://github.com/sebastianbergmann/phpunit/graphs/contributors)
91  
-- [PHP code coverage](https://github.com/sebastianbergmann/php-code-coverage/graphs/contributors)
92  
-- [PHPUnit mock objects](https://github.com/sebastianbergmann/phpunit-mock-objects/graphs/contributors)
93  
-
94  
-A very special thanks to everyone that has contributed to the documentation and helped maintaining the translations:
95  
-
96  
-- [PHPUnit Documentation](https://github.com/sebastianbergmann/phpunit-documentation/graphs/contributors)
97  
-
98  
-### Running the test suite(s)
99  
-
100  
-It's not possible to use a system wide installed version of PHPUnit to run the test suite of a git checkout. Because of that is is necessary to change the include paths like describe above.
101  
-
102  
-This can be achieved with a small wrapper script designed to work with every module in the PHPUnit stack.
103  
-
104  
-Note that you might have to change the path to your pear installation here pointing to `/usr/local/lib/php`. You can find it using `pear config-show | grep php_dir`
105  
-
106  
-**Linux/Mac**
107  
-
108  
-`run-tests.sh`
109  
-
110  
-> \#!/bin/bash
111  
->
112  
-> php -d include_path='.:../phpunit/:../dbunit/:../php-code-coverage/:../php-file-iterator/:../php-invoker/:../php-text-template/:../php-timer:../php-token-stream:../phpunit-mock-objects/:../phpunit-selenium/:../phpunit-story/:/usr/local/lib/php' ../phpunit/phpunit.php $*
113  
-
114  
-**Windows**
115  
-
116  
-`run-tests.bat`
117  
-
118  
-> @echo off
119  
->
120  
-> php -d include_path='.;../phpunit/;../dbunit/;../php-code-coverage/;../php-file-iterator/;../php-invoker/;../php-text-template/;../php-timer;../php-token-stream;../phpunit-mock-objects/;../phpunit-selenium/;../phpunit-story/;C:/Program Files/PHP/pear' ../phpunit/phpunit.php %*
121  
-
62  README.md
Source Rendered
... ...
@@ -0,0 +1,62 @@
  1
+PHPUnit
  2
+=======
  3
+
  4
+PHPUnit is the de-facto standard for unit testing in PHP projects. It provides both a framework that makes the writing of tests easy as well as the functionality to easily run the tests and analyse their results.
  5
+
  6
+Requirements
  7
+------------
  8
+
  9
+* PHPUnit 3.7 requires PHP 5.3.3 (or later) but PHP 5.4.6 (or later) is highly recommended.
  10
+* [PHP_CodeCoverage](http://github.com/sebastianbergmann/php-code-coverage), the library that is used by PHPUnit to collect and process code coverage information, depends on [Xdebug](http://xdebug.org/) 2.0.5 (or later) but Xdebug 2.2.1 (or later) is highly recommended.
  11
+
  12
+Installation
  13
+------------
  14
+
  15
+PHPUnit should be installed using the PEAR Installer, the backbone of the [PHP Extension and Application Repository](http://pear.php.net/) that provides a distribution system for PHP packages.
  16
+
  17
+Depending on your OS distribution and/or your PHP environment, you may need to install PEAR or update your existing PEAR installation before you can proceed with the following instructions. `sudo pear upgrade PEAR` usually suffices to upgrade an existing PEAR installation. The [PEAR Manual ](http://pear.php.net/manual/en/installation.getting.php) explains how to perform a fresh installation of PEAR.
  18
+
  19
+The following two commands (which you may have to run as `root`) are all that is required to install PHPUnit using the PEAR Installer:
  20
+
  21
+    pear config-set auto_discover 1
  22
+    pear install pear.phpunit.de/PHPUnit
  23
+
  24
+After the installation you can find the PHPUnit source files inside your local PEAR directory; the path is usually `/usr/lib/php/PHPUnit`.
  25
+
  26
+Documentation
  27
+-------------
  28
+
  29
+The documentation for PHPUnit is available in different formats:
  30
+
  31
+* [English, multiple HTML files](http://www.phpunit.de/manual/3.7/en/index.html)
  32
+* [English, single HTML file](http://www.phpunit.de/manual/3.7/en/phpunit-book.html)
  33
+* [English, PDF](http://www.phpunit.de/manual/3.7/en/phpunit-book.pdf)
  34
+* [English, ePub](http://www.phpunit.de/manual/3.7/en/phpunit-book.epub)
  35
+* [French, multiple HTML files](http://www.phpunit.de/manual/3.7/fr/index.html)
  36
+* [French, single HTML file](http://www.phpunit.de/manual/3.7/fr/phpunit-book.html)
  37
+* [French, PDF](http://www.phpunit.de/manual/3.7/fr/phpunit-book.pdf)
  38
+* [French, ePub](http://www.phpunit.de/manual/3.7/fr/phpunit-book.epub)
  39
+* [Japanese, multiple HTML files](http://www.phpunit.de/manual/3.7/ja/index.html)
  40
+* [Japanese, single HTML file](http://www.phpunit.de/manual/3.7/ja/phpunit-book.html)
  41
+* [Japanese, PDF](http://www.phpunit.de/manual/3.7/ja/phpunit-book.pdf)
  42
+* [Japanese, ePub](http://www.phpunit.de/manual/3.7/ja/phpunit-book.epub)
  43
+
  44
+IRC
  45
+---
  46
+
  47
+The [#phpunit channel on the Freenode IRC network](irc://freenode.net/phpunit) is a place to chat about PHPUnit.
  48
+
  49
+List of Contributors
  50
+--------------------
  51
+
  52
+Thanks to everyone who has contributed to PHPUnit! You can find a detailed list of contributors on every PHPUnit related package on GitHub. This list shows only the major components:
  53
+
  54
+- [PHPUnit](https://github.com/sebastianbergmann/phpunit/graphs/contributors)
  55
+- [PHP_CodeCoverage](https://github.com/sebastianbergmann/php-code-coverage/graphs/contributors)
  56
+- [PHPUnit_MockObject](https://github.com/sebastianbergmann/phpunit-mock-objects/graphs/contributors)
  57
+
  58
+A very special thanks to everyone who has contributed to the documentation and helps maintaining the translations:
  59
+
  60
+- [PHPUnit Documentation](https://github.com/sebastianbergmann/phpunit-documentation/graphs/contributors)
  61
+
  62
+Please refer to [CONTRIBUTING.md](https://github.com/sebastianbergmann/phpunit/blob/master/CONTRIBUTING.markdown) for information on how to contribute to PHPUnit and its related projects.

0 notes on commit f634bc1

Please sign in to comment.
Something went wrong with that request. Please try again.