CONTRIBUTING.md (2807B)
1 # Contributing to PHPUnit 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 based on the current stable branch whereas pull requests for new features must be based on the current alpha branch (when `5.0` is the current stable branch, then `5.1` is the current beta branch and `5.2` is the current alpha 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 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 $ wget http://get.sensiolabs.org/php-cs-fixer.phar 28 29 $ php php-cs-fixer.phar fix 30 ``` 31 32 ## Using PHPUnit from a Git checkout 33 34 The following commands can be used to perform the initial checkout of PHPUnit: 35 36 ```bash 37 $ git clone git://github.com/sebastianbergmann/phpunit.git 38 39 $ cd phpunit 40 ``` 41 42 Retrieve PHPUnit's dependencies using [Composer](http://getcomposer.org/): 43 44 ```bash 45 $ wget http://getcomposer.org/composer.phar 46 47 $ php composer.phar install 48 ``` 49 50 The `phpunit` script can be used to invoke the PHPUnit test runner: 51 52 ```bash 53 $ ./phpunit --version 54 ``` 55 56 ## Reporting issues 57 58 Please use the most specific issue tracker to search for existing tickets and to open new tickets: 59 60 * [General problems](https://github.com/sebastianbergmann/phpunit/issues) 61 * [Code Coverage](https://github.com/sebastianbergmann/php-code-coverage/issues) 62 * [Stub and Mock Objects](https://github.com/sebastianbergmann/phpunit-mock-objects/issues) 63 * [DbUnit](https://github.com/sebastianbergmann/dbunit/issues) 64 * [PHPUnit_Selenium](https://github.com/sebastianbergmann/phpunit-selenium/issues) 65 * [Documentation](https://github.com/sebastianbergmann/phpunit-documentation/issues) 66 * [Website](https://github.com/sebastianbergmann/phpunit-website/issues) 67