You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

35 lines
1.0 KiB

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