| commit | author | age | ||
| 2207d6 | 1 | # Contributing to PHPUnit |
| W | 2 | |
| 3 | ## Contributor Code of Conduct | |
| 4 | ||
| 5 | Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. | |
| 6 | ||
| 7 | ## Workflow | |
| 8 | ||
| 9 | * Fork the project. | |
| 10 | * Make your bug fix or feature addition. | |
| 11 | * Add tests for it. This is important so we don't break it in a future version unintentionally. | |
| 12 | * Send a pull request. Bonus points for topic branches. | |
| 13 | ||
| 14 | Please make sure that you have [set up your user name and email address](http://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup) for use with Git. Strings such as `silly nick name <root@localhost>` look really stupid in the commit history of a project. | |
| 15 | ||
| 16 | Pull requests for bug fixes must be made for the oldest branch that is [supported](https://phpunit.de/supported-versions.html). Pull requests for new features must be based on the `master` branch. | |
| 17 | ||
| 18 | We are trying to keep backwards compatibility breaks in PHPUnit to an absolute minimum. Please take this into account when proposing changes. | |
| 19 | ||
| 20 | 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 if you feel that we forgot to respond. | |
| 21 | ||
| 22 | ## Coding Guidelines | |
| 23 | ||
| 24 | This project comes with a configuration file and an executable for [php-cs-fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) (`.php_cs`) that you can use to (re)format your sourcecode for compliance with this project's coding guidelines: | |
| 25 | ||
| 26 | ```bash | |
| 27 | $ ./build/tools/php-cs-fixer fix | |
| 28 | ``` | |
| 29 | ||
| 30 | ## Using PHPUnit from a Git checkout | |
| 31 | ||
| 32 | The following commands can be used to perform the initial checkout of PHPUnit: | |
| 33 | ||
| 34 | ```bash | |
| 35 | $ git clone git://github.com/sebastianbergmann/phpunit.git | |
| 36 | ||
| 37 | $ cd phpunit | |
| 38 | ``` | |
| 39 | ||
| 40 | Retrieve PHPUnit's dependencies using [Composer](https://getcomposer.org/): | |
| 41 | ||
| 42 | ```bash | |
| 43 | $ composer install | |
| 44 | ``` | |
| 45 | ||
| 46 | The `phpunit` script can be used to invoke the PHPUnit test runner: | |
| 47 | ||
| 48 | ```bash | |
| 49 | $ ./phpunit --version | |
| 50 | ``` | |
| 51 | ||
| 52 | ## Running PHPUnit's own test suite | |
| 53 | ||
| 54 | After following the steps shown above, PHPUnit's own test suite is run like this: | |
| 55 | ||
| 56 | ```bash | |
| 57 | $ ./phpunit | |
| 58 | ``` | |
| 59 | ||
| 60 | ## Reporting issues | |
| 61 | ||
| 62 | Please use the most specific issue tracker to search for existing tickets and to open new tickets: | |
| 63 | ||
| 64 | * [General problems](https://github.com/sebastianbergmann/phpunit/issues) | |
| 65 | * [Code Coverage](https://github.com/sebastianbergmann/php-code-coverage/issues) | |
| 66 | * [Stub and Mock Objects](https://github.com/sebastianbergmann/phpunit-mock-objects/issues) | |
| 67 | * [Documentation](https://github.com/sebastianbergmann/phpunit-documentation/issues) | |
| 68 | * [Website](https://github.com/sebastianbergmann/phpunit-website/issues) | |
| 69 | ||
