Jingga/Organization-Guide
1
0
Fork 0
mirror of https://github.com/Karaka-Management/Organization-Guide.git synced 2026-02-08 08:58:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update 01_Development.md

Browse Source 
Signed-off-by: Dennis Eichhorn <spl1nes.com@googlemail.com>
This commit is contained in:
Dennis Eichhorn 2024-03-20 09:20:00 +01:00 committed by GitHub
parent ce69a08a6f
commit ef3fca9436
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Processes/01_Development.md
View File

@ -98,7 +98,7 @@ If the code reviewer only finds minor issues with the proposed code change the r
#### Demo #### Demo
Some code changes may also require changes or extensions in the demo setup scripts. The demo setup script try to simulate a real world use case by generating and modifying mostly random data. This is also a good way to setup and “manually” test the code changes in a larger picture. The demo setup script can be found in the [demoSetup](https://github.com/Karaka-Management/demoSetup) repository. The demo setup script takes a long time due to the large amount of user input simulated data which is generated. Therefore it is recommended to run this only sporadically. (**R9**) Some code changes may also require changes or extensions in the demo setup scripts. The demo setup script tries to simulate a "real world" use case by generating and modifying mostly random data. This is also a good way to setup and “manually” test the code changes in a larger picture. The demo setup script can be found in the [demoSetup](https://github.com/Karaka-Management/demoSetup) repository. The demo setup script takes a long time due to the large amount of user input simulated data which is generated. Therefore it is recommended to run this only sporadically. (**R9**)
```sh ```sh
sudo -u www-data php -dxdebug.remote_enable=1 -dxdebug.start_with_request=yes -dxdebug.mode=coverage,develop,debug demoSetup/setup.php sudo -u www-data php -dxdebug.remote_enable=1 -dxdebug.start_with_request=yes -dxdebug.mode=coverage,develop,debug demoSetup/setup.php
@ -120,19 +120,17 @@ If a developer (or employee in general) has an idea for an improvement, feature
In case SCSS/CSS or JS files got changed they must get re-built locally before comitting the code change: In case SCSS/CSS or JS files got changed they must get re-built locally before comitting the code change:
```sh ```sh
npx esbuild Web/Backend/js/backend.js --bundle --outfile=Install/Application/Backend/js/backend.min.js --minify npm build release # or npm build develop during testing
scss cssOMS/styles.scss > cssOMS/styles.css npm build scss
``` ```
For JS you may also use the shorthand command `npm run build`.
Code changes must be performed in a new branch. A new branch can be created with: Code changes must be performed in a new branch. A new branch can be created with:
```sh ```sh
git checkout -b new-branch-name 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: The name of the branch can be chosen freely however, it is recommended to follow the following branch naming conventions:
* `feature-*` for feature implementations * `feature-*` for feature implementations
* `hotfix-*` for security related fixes/improvements * `hotfix-*` for security related fixes/improvements