update documentation

This commit is contained in:
Dennis Eichhorn 2023-10-03 15:51:27 +02:00
parent c9b186c8dd
commit 43a2e4fb8b
6 changed files with 43 additions and 9 deletions

View File

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

View File

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

View File

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

View File

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

View File

@ -24,7 +24,7 @@ Name:
\* Not available in the employee evaluation form, only in this form.
## Other remarks
## Other remarks, requests, suggestions
....

View File

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