summaryrefslogtreecommitdiff
path: root/vendor/doctrine/collections/CONTRIBUTING.md
diff options
context:
space:
mode:
authorDevian <devianleong@gmail.com>2021-04-22 17:03:46 +0800
committerDevian <devianleong@gmail.com>2021-04-22 17:03:46 +0800
commit745cf2431a71d0e6c5f08f8605839279b2f7496e (patch)
tree11e4c7a19ac9f9efc1bb253b29b1fa488c34238e /vendor/doctrine/collections/CONTRIBUTING.md
Initiate commit
Diffstat (limited to 'vendor/doctrine/collections/CONTRIBUTING.md')
-rw-r--r--vendor/doctrine/collections/CONTRIBUTING.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/vendor/doctrine/collections/CONTRIBUTING.md b/vendor/doctrine/collections/CONTRIBUTING.md
new file mode 100644
index 0000000..83437da
--- /dev/null
+++ b/vendor/doctrine/collections/CONTRIBUTING.md
@@ -0,0 +1,54 @@
+# 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 the [Doctrine Coding Standard](https://github.com/doctrine/coding-standard).
+
+## 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:
+
+```sh
+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](https://www.travis-ci.org)
+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!