summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMichael Weimann <mail@michael-weimann.eu>2019-12-01 15:50:31 +0100
committerIgor Scheller <igor.scheller@igorshp.de>2020-01-20 02:23:16 +0100
commitf78e8c50bf8d6956c63cdba25437c9ba89a73a1d (patch)
tree03e97582e9ace297e60ae48644f52ffeceeae64b /CONTRIBUTING.md
parent94753bc3d866071980148a2fd9e1bd5fa72b7a13 (diff)
Add CONTRIBUTING.md
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..9a1dee53
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,10 @@
+# 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.
+* 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.