[Summary view] [Print] [Text view]

   1  ---
   2  title: Contributing
   3  ---
   4  
   5  # Contributing
   6  
   7   * Coding standard for the project is [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)
   8   * The project will follow strict [object calisthenics](http://www.slideshare.net/guilhermeblanco/object-calisthenics-applied-to-php)
   9   * Any contribution must provide tests for additional introduced conditions
  10   * Any un-confirmed issue needs a failing test case before being accepted
  11   * Pull requests must be sent from a new hotfix/feature branch, not from `master`.
  12  
  13  ## Installation
  14  
  15  To install the project and run the tests, you need to clone it first:
  16  
  17  ```sh
  18  $ git clone git://github.com/Ocramius/PackageVersions.git
  19  ```
  20  
  21  You will then need to run a composer installation:
  22  
  23  ```sh
  24  $ cd PackageVersions
  25  $ curl -s https://getcomposer.org/installer | php
  26  $ php composer.phar update
  27  ```
  28  
  29  ## Testing
  30  
  31  The PHPUnit version to be used is the one installed as a dev- dependency via composer:
  32  
  33  ```sh
  34  $ ./vendor/bin/phpunit
  35  ```
  36  
  37  Accepted coverage for new contributions is 80%. Any contribution not satisfying this requirement 
  38  won't be merged.
  39