From 43a2e4fb8bd732f3ee8d15a45a3d0a96bbcfdde4 Mon Sep 17 00:00:00 2001 From: Dennis Eichhorn Date: Tue, 3 Oct 2023 15:51:27 +0200 Subject: [PATCH] update documentation --- Processes/01_Development.md | 30 +++++++++++++++++-- Processes/05_HR.md | 2 +- .../Company Evaluation Form.md | 8 +++++ .../Employee Evaluation Form.md | 2 +- .../Evaluation Forms/Self-Evaluation Form.md | 2 +- Processes/IT/Outsourced Services.md | 8 ++--- 6 files changed, 43 insertions(+), 9 deletions(-) diff --git a/Processes/01_Development.md b/Processes/01_Development.md index c735044..4dfe142 100644 --- a/Processes/01_Development.md +++ b/Processes/01_Development.md @@ -48,6 +48,7 @@ Automated checks which are run during the review process (**R4**): ```sh php ./vendor/bin/phpcs ./ --standard="Build/Config/phpcs.xml" +php ./vendor/bin/rector process --dry-run --config Build/Config/rector.php ./ npx eslint ./ -c ./Build/Config/.eslintrc.json ``` @@ -61,7 +62,7 @@ Automated tests which are run during the review process (**R7**): ```sh php ./vendor/bin/phpunit -c tests/PHPUnit/phpunit_default.xml -php ./vendor/bin/phpstan analyse --autoload-file=phpOMS/Autoloader.php -l 9 -c Build/Config/phpstan.neon ./ +php ./vendor/bin/phpstan analyse --no-progress -l 9 -c Build/Config/phpstan.neon ./ npx jasmine-node ./ ./cOMS/tests/test.sh ``` @@ -102,21 +103,33 @@ git checkout -b new-branch-name The name of the branch can be chosen freely however it is recommended to follow the following branch naming conventions: * `feature-*` for feature implementations +* `hotfix-*` for security related fixes/improvements * `bug-*` for bug fixes * `security-*` for security related fixes/improvements -* `general-*` for general improvements (i.e. code documentation improvements, code style improvements) +* `general-*` for general improvements (i.e. documentation, code style & performance improvements) ```mermaid %%{init: { 'gitGraph': {'mainBranchName': 'master'}} }%% gitGraph commit + branch hotfix-xxx + commit + checkout master branch develop + checkout master + merge hotfix-xxx + checkout develop branch bug-xxx commit commit + checkout hotfix-xxx + commit + checkout master + merge hotfix-xxx checkout develop merge bug-xxx commit + checkout develop branch feature-xxx commit commit @@ -125,6 +138,19 @@ The name of the branch can be chosen freely however it is recommended to follow merge feature-xxx checkout master merge develop + checkout develop + branch general-xxx + commit + checkout develop + merge general-xxx + branch security-xxx + commit + commit + checkout develop + merge security-xxx + checkout master + merge develop + ``` The senior developer who performs the code review merges the change request into the `develop` branch after their successful code review. Unsuccessful reviews lead to change requests by the original developer, other developers who can make the requested changes, changes by the senior developer who performed the review, or dismissal of the changed code. (**R10**) diff --git a/Processes/05_HR.md b/Processes/05_HR.md index e95809d..0fc07a8 100644 --- a/Processes/05_HR.md +++ b/Processes/05_HR.md @@ -172,6 +172,6 @@ Every employee is checked automatically every night against sanctions lists in t ## Other related documents -* [Onboarding Does and Donts](./HR/Hiring/Onboarding/Onboarding%20Does%20and%20Donts.md) +* [Onboarding Does and Donts](./HR/Onboarding/Onboarding%20Does%20and%20Donts.md) 2022-01-01 - Version 1.0 diff --git a/Processes/HR/Evaluation Forms/Company Evaluation Form.md b/Processes/HR/Evaluation Forms/Company Evaluation Form.md index 3242b26..a5f1037 100644 --- a/Processes/HR/Evaluation Forms/Company Evaluation Form.md +++ b/Processes/HR/Evaluation Forms/Company Evaluation Form.md @@ -10,6 +10,10 @@ | 4 | The company is successful. | | | | | | | 5 | I am happy with the company. | | | | | | +### Other remarks, requests, suggestions + +.... + ## Your team | No. | Topic | Very Confident | Fairly Confident | Not Very Confident | Not At All Confident | Notes | @@ -20,5 +24,9 @@ | 4 | My team is performing well. | | | | | | | 5 | I am happy with team. | | | | | | +### Other remarks, requests, suggestions + +.... + 2022-01-01 - Version 1.0 diff --git a/Processes/HR/Evaluation Forms/Employee Evaluation Form.md b/Processes/HR/Evaluation Forms/Employee Evaluation Form.md index 8e5ca0b..628c9b0 100644 --- a/Processes/HR/Evaluation Forms/Employee Evaluation Form.md +++ b/Processes/HR/Evaluation Forms/Employee Evaluation Form.md @@ -21,7 +21,7 @@ Name: | 15 | The employee is good at leading their subordinates. | | | | | | | 16 | The employee is sufficiently qualified for their current job/tasks. | | | | | | -## Other remarks +## Other remarks, requests, suggestions .... diff --git a/Processes/HR/Evaluation Forms/Self-Evaluation Form.md b/Processes/HR/Evaluation Forms/Self-Evaluation Form.md index edbd69f..7d02fd8 100644 --- a/Processes/HR/Evaluation Forms/Self-Evaluation Form.md +++ b/Processes/HR/Evaluation Forms/Self-Evaluation Form.md @@ -24,7 +24,7 @@ Name: \* Not available in the employee evaluation form, only in this form. -## Other remarks +## Other remarks, requests, suggestions .... diff --git a/Processes/IT/Outsourced Services.md b/Processes/IT/Outsourced Services.md index 22a7254..8c4c9bd 100644 --- a/Processes/IT/Outsourced Services.md +++ b/Processes/IT/Outsourced Services.md @@ -1,6 +1,6 @@ # Outsourced Services -| Service | Description | Vendor | -| --------------- | ----------------------- | -------------------- | -| Hosting | Website hosting | ispOne business GmbH | -| Version control | Version control hosting | Microsoft | +| Service | Description | Vendor | +| --------------- | ----------------------- | --------- | +| Hosting | Website hosting | IONOS SE | +| Version control | Version control hosting | Microsoft |