Contribute to Doctrine

Thank you for contributing to Doctrine!

Before we can merge your Pull-Request here are some guidelines that you need to follow. These guidelines exist not to annoy you, but to keep the code base clean, unified and future proof.

We only accept PRs to "master"

Our branching strategy is "everything to master first", even bugfixes and we then merge them into the stable branches. You should only open pull requests against the master branch. Otherwise we cannot accept the PR.

There is one exception to the rule, when we merged a bug into some stable branches we do occasionally accept pull requests that merge the same bug fix into earlier branches.

Coding Standard

We use doctrine coding standard which is PSR-1 and PSR-2:

• https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md
• https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md

with some exceptions/differences:

• Keep the nesting of control structures per method as small as possible
• Align equals (=) signs
• Add spaces between assignment, control and return statements
• Prefer early exit over nesting conditions
• Add spaces around a negation if condition ``if ( ! $cond)``
• Add legal information at the beginning of each source file
• Add ``@author`` phpDoc comment at DockBlock of class/interface/trait that you create.

Unit-Tests

Please try to add a test for your pull-request.

• If you want to contribute new functionality add unit- or functional tests depending on the scope of the feature.

You can run the unit-tests by calling `vendor/bin/phpunit` from the root of the project. It will run all the project tests.

In order to do that, you will need a fresh copy of doctrine/collections, and you will have to run a composer installation in the project:

git clone git@github.com:doctrine/collections.git
cd collections
curl -sS https://getcomposer.org/installer | php --
./composer.phar install

Travis

We automatically run your pull request through Travis CI against supported PHP versions. If you break the tests, we cannot merge your code, so please make sure that your code is working before opening up a Pull-Request.

Getting merged

Please allow us time to review your pull requests. We will give our best to review everything as fast as possible, but cannot always live up to our own expectations.

Thank you very much again for your contribution!