Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added a small 'Contributing' section to the README.

  • Loading branch information...
commit 4a3cafbb21e602db8ef651016472c17182e50e16 1 parent 4c39b23
@edorian edorian authored
Showing with 48 additions and 0 deletions.
  1. +48 −0 README.markdown
View
48 README.markdown
@@ -79,3 +79,51 @@ The following commands can be used to check out the appropriate branches for PHP
cd php-code-coverage && git checkout 1.1 && cd ..
cd phpunit-mock-objects && git checkout 1.1 && cd ..
cd phpunit-selenium && git checkout 1.1 && cd ..
+
+Contributing
+------------
+
+Contributions to PHPUnit, its related modules and its documentation are always welcome and best done using GitHub pull request.
+
+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.
+
+We are trying to keep BC breaks in PHPUnit 3.7 to a absolute minimum so please take this into account when proposing changes.
+
+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.
+
+### List of Contributors
+
+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:
+
+- [PHPUnit core](https://github.com/sebastianbergmann/phpunit/graphs/contributors)
+- [PHP code coverage](https://github.com/sebastianbergmann/php-code-coverage/graphs/contributors)
+- [PHPUnit mock objects](https://github.com/sebastianbergmann/phpunit-mock-objects/graphs/contributors)
+
+A very special thanks to everyone that has contributed to the documentation and helped maintaining the translations:
+
+- [PHPUnit Documentation](https://github.com/sebastianbergmann/phpunit-documentation/graphs/contributors)
+
+### Running the test suite(s)
+
+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.
+
+This can be achieved with a small wrapper script designed to work with every module in the PHPUnit stack.
+
+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`
+
+**Linux/Mac**
+
+`run-tests.sh`
+
+> \#!/bin/bash
+>
+> 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 $*
+
+**Windows**
+
+`run-tests.bat`
+
+> @echo off
+>
+> 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 %*
+
Please sign in to comment.
Something went wrong with that request. Please try again.