summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMichael Weimann <mail@michael-weimann.eu>2020-01-17 14:58:42 +0100
committerIgor Scheller <igor.scheller@igorshp.de>2020-01-20 02:23:16 +0100
commitd6ff7b58161d80959a0880f0ddb37e3cf5ee91a0 (patch)
tree1af6ad468e6cbe26eaf7f05780648bac99a5da87 /CONTRIBUTING.md
parentf78e8c50bf8d6956c63cdba25437c9ba89a73a1d (diff)
Update docs
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9a1dee53..94724364 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,10 +1,11 @@
# Contributing
-
-## Code style
-
-* Make sure your code follows the [PSR-12](https://www.php-fig.org/psr/psr-12/) code style.
-You may use `composer run phpcs` to verify that.
+## Coding guide lines
+* Make sure you code follows the [PSR-12](https://www.php-fig.org/psr/psr-12/) code style.
+ You may use `composer run phpcs` to verify that.
* Use `use` statements wherever possible instead of writing the fully qualified name.
* Order the composer/npm dependencies alphabetically.
* Do not use code from the [includes](./includes) directory anywhere else.
-* If possible cover your code by test cases.
+* Please cover your code by unit tests. Code under `includes` does not require tests.
+
+## Pull requests
+Please create single pull requests for every feature instead of creating one big monster of pull request containing a complete rewrite.