~tcuthbert/wordpress/openstack-objectstorage

« back to all changes in this revision

Viewing changes to vendor/doctrine/instantiator/CONTRIBUTING.md

  • Committer: Jacek Nykis
  • Date: 2015-02-11 15:35:31 UTC
  • Revision ID: jacek.nykis@canonical.com-20150211153531-hmy6zi0ov2qfkl0b
Initial commit

Show diffs side-by-side

added added

removed removed

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