iger
/
engelsystem
9
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add CONTRIBUTING.md

This commit is contained in:
Michael Weimann 2019-12-01 15:50:31 +01:00 committed by Igor Scheller
parent 94753bc3d8
commit f78e8c50bf
2 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md Normal file
View File

@ -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.

2
README.md
View File

@ -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