Jingga/Developer-Guide
1
0
Fork 0
mirror of https://github.com/Karaka-Management/Developer-Guide.git synced 2026-02-02 14:18:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix name

Browse Source
This commit is contained in:
Dennis Eichhorn 2022-02-19 14:25:28 +01:00
parent 9e3727c730
commit b08fac5938
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
general/setup.md
View File

@ -33,7 +33,7 @@ This also installs all required dev tools and sets up the directory structure by
The following steps will setup the application, download all necessary tools and perform extensive code quality checks and documentation tasks: The following steps will setup the application, download all necessary tools and perform extensive code quality checks and documentation tasks:
1. Go to the directory where you want to install the build script 1. Go to the directory where you want to install the build script
2. Run `git clone -b develop https://github.comkaraka-management/Build.git` 2. Run `git clone -b develop https://github.com/karaka-management/Build.git`
3. Modify `config.sh` (most likely the db credentials and paths) 3. Modify `config.sh` (most likely the db credentials and paths)
4. Run `chmod +x buildProject.sh` 4. Run `chmod +x buildProject.sh`
5. Run `./buildProject.sh` 5. Run `./buildProject.sh`
@ -58,7 +58,7 @@ This will only setup the application including some dummy data and also perform
### Steps ### Steps
1. Go to the directory where you want to install the application 1. Go to the directory where you want to install the application
2. Run `git clone -b develop https://github.comkaraka-management/Karaka.git` 2. Run `git clone -b develop https://github.com/karaka-management/Karaka.git`
3. Run `git submodule update --init --recursive` 3. Run `git submodule update --init --recursive`
4. Run `git submodule foreach git checkout develop` 4. Run `git submodule foreach git checkout develop`
5. Install Composer 5. Install Composer
@ -101,7 +101,7 @@ The following tools are important to test the application and to ensure the code
This will only setup the application including some dummy data and also perform the code tests but no quality checks. Compared to option 2 this includes much more test data and it doesn't execute a unit test. This will only setup the application including some dummy data and also perform the code tests but no quality checks. Compared to option 2 this includes much more test data and it doesn't execute a unit test.
1. Go to the directory where you want to install the application 1. Go to the directory where you want to install the application
2. Run `git clone -b develop https://github.comkaraka-management/Karaka.git` 2. Run `git clone -b develop https://github.com/karaka-management/Karaka.git`
3. Run `git submodule update --init --recursive` 3. Run `git submodule update --init --recursive`
4. Run `git submodule foreach git checkout develop` 4. Run `git submodule foreach git checkout develop`
5. Install Composer 5. Install Composer

2
standards/documentation.md
View File

@ -175,7 +175,7 @@ In some cases it may be required to type hint a variable in this case the follow
## Todos ## Todos
Todos should be documented in the [PROJECT.md](https://github.comkaraka-management/Docs/blob/master/Project/PROJECT.md). Todos should be documented in the [PROJECT.md](https://github.com/karaka-management/Docs/blob/master/Project/PROJECT.md).
In code todos can be created like this In code todos can be created like this