diff options
| -rw-r--r-- | CONTRIBUTING.md | 10 | ||||
| -rw-r--r-- | README.md | 2 |
2 files changed, 12 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. @@ -87,6 +87,8 @@ Since the engelsystem is open source, you can help to improve the system. We rea Please create single pull requests for every feature instead of creating one big monster of pull request containing a complete rewrite. +Please read the [CONTRIBUTING.md](./CONTRIBUTING.md) before you start. + ### Testing To run the unit tests use ```bash |