diff options
Diffstat (limited to 'vendor/doctrine/collections/CONTRIBUTING.md')
-rw-r--r-- | vendor/doctrine/collections/CONTRIBUTING.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/vendor/doctrine/collections/CONTRIBUTING.md b/vendor/doctrine/collections/CONTRIBUTING.md new file mode 100644 index 0000000..7a0a8c9 --- /dev/null +++ b/vendor/doctrine/collections/CONTRIBUTING.md | |||
@@ -0,0 +1,44 @@ | |||
1 | # Contribute to Doctrine | ||
2 | |||
3 | Thank you for contributing to Doctrine! | ||
4 | |||
5 | Before we can merge your Pull-Request here are some guidelines that you need to follow. | ||
6 | These guidelines exist not to annoy you, but to keep the code base clean, | ||
7 | unified and future proof. | ||
8 | |||
9 | ## Coding Standard | ||
10 | |||
11 | We use the [Doctrine Coding Standard](https://github.com/doctrine/coding-standard). | ||
12 | |||
13 | ## Unit-Tests | ||
14 | |||
15 | Please try to add a test for your pull-request. | ||
16 | |||
17 | * If you want to contribute new functionality add unit- or functional tests | ||
18 | depending on the scope of the feature. | ||
19 | |||
20 | You can run the unit-tests by calling ``vendor/bin/phpunit`` from the root of the project. | ||
21 | It will run all the project tests. | ||
22 | |||
23 | In order to do that, you will need a fresh copy of doctrine/collections, and you | ||
24 | will have to run a composer installation in the project: | ||
25 | |||
26 | ```sh | ||
27 | git clone git@github.com:doctrine/collections.git | ||
28 | cd collections | ||
29 | curl -sS https://getcomposer.org/installer | php -- | ||
30 | ./composer.phar install | ||
31 | ``` | ||
32 | |||
33 | ## Github Actions | ||
34 | |||
35 | We automatically run your pull request through Github Actions against supported | ||
36 | PHP versions. If you break the tests, we cannot merge your code, so please make | ||
37 | sure that your code is working before opening up a Pull-Request. | ||
38 | |||
39 | ## Getting merged | ||
40 | |||
41 | Please allow us time to review your pull requests. We will give our best to review | ||
42 | everything as fast as possible, but cannot always live up to our own expectations. | ||
43 | |||
44 | Thank you very much again for your contribution! | ||