From 12a707ea3d9b39deec07da459736d0dee61336a1 Mon Sep 17 00:00:00 2001 From: Dennis Eichhorn Date: Fri, 17 May 2019 23:02:13 +0200 Subject: [PATCH] Remove unavailable tools --- quality/inspections.md | 3 +-- setup/developer_environment.md | 4 +--- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/quality/inspections.md b/quality/inspections.md index 2781ab5..76b9945 100644 --- a/quality/inspections.md +++ b/quality/inspections.md @@ -8,7 +8,6 @@ Tools used for the code inspection are: * PhpLoc * PhpMetrics -* PDepend * PhpUnit (see tests) * Jasmine (see tests) * Custom scripts/tools @@ -23,6 +22,6 @@ As external tool scrutinizer is used to automate code inspection and provide ins For developers it is recommended to copy the contents of the `default.sh` file in the `Build` repository under `Hooks` to your `pre-commit` file in the `.git/hooks` directory. If the `pre-commit` file doesn't exist just create it. -The same should be done with every module. Simply go to `.git/modules/**/hooks` and also add the content of the `default.sh` file to all `pre-commit` files. +The same should be done with every module. Simply go to `.git/modules/**/hooks` and also add the content of the `default.sh` file to all `pre-commit` files. By doing this every commit will be inspected and either pass without warnings, pass with warnings or stop with errors. This will allow you to fix code before committing it. Be aware only changed files will be inspected. Also make sure all `pre-commit` have `+x` permissions. \ No newline at end of file diff --git a/setup/developer_environment.md b/setup/developer_environment.md index 7526da5..c73b473 100644 --- a/setup/developer_environment.md +++ b/setup/developer_environment.md @@ -23,9 +23,7 @@ The following tools are important to test the application and to ensure the code * phploc * phpunit * phpcs -* phpmd * phpmetrics -* pdepend * documentor * phpstan * phan @@ -34,6 +32,6 @@ The following tools are important to test the application and to ensure the code For developers it is recommended to copy the contents of the `default.sh` file in the `Build` repository under `Hooks` to your `pre-commit` file in the `.git/hooks` directory. If the `pre-commit` file doesn't exist just create it. -The same should be done with every module. Simply go to `.git/modules/**/hooks` and also add the content of the `default.sh` file to all `pre-commit` files. +The same should be done with every module. Simply go to `.git/modules/**/hooks` and also add the content of the `default.sh` file to all `pre-commit` files. By doing this every commit will be inspected and either pass without warnings, pass with warnings or stop with errors. This will allow you to fix code before committing it. Be aware only changed files will be inspected. Also make sure all `pre-commit` have `+x` permissions. \ No newline at end of file