diff --git a/.doc/developers.md b/.doc/developers.md new file mode 100644 index 000000000..278cae5cd --- /dev/null +++ b/.doc/developers.md @@ -0,0 +1,9 @@ +# Developers + +## PHP Code Styles +We use `PHP CS Fixer` to ensure code formating consistency across PHP codebase. +You can find the configuration and instructions to run it [here](../tests/php-code-style/README.md). + +## PHP Static Analysis +We use `PHPStan` to ensure code quality and to detect potential bugs in our PHP codebase. +You can find the configuration and instructions to run it [here](../tests/php-code-style/README.md). \ No newline at end of file diff --git a/README.md b/README.md index 0b5651667..a6f98d02d 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,9 @@ iTop development is sponsored, led, and supported by [Combodo][0]. [0]: https://www.combodo.com +## Developers + +You can find information and instructions about our quality tools and how to run them [here](.doc/developers.md). ## Contributors