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

add todo/issue policy

Browse Source
This commit is contained in:
Dennis Eichhorn 2020-01-05 21:38:23 +01:00
parent c42d3e8abd
commit 9063b57530
1 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
standards/general.md
View File

@ -36,7 +36,7 @@ Always use a whitespace **after**:
Always use a whitespace **before** and **after**: Always use a whitespace **before** and **after**:
* assignment (e.g. `=`, `=>`, `+=`, `/=`, `*=`, `-=`, `.=`) * assignment (e.g. `=`, `=>`, `+=`, `/=`, `*=`, `-=`, `.=`)
* math operations (e.g. `+`, `-`, `*`, `/`, `%`, `&`, `|`, `**`, `>>`, `<<`) * math operations (e.g. `+`, `-`, `*`, `/`, `%`, `&`, `|`, `**`, `>>`, `<<`)
* logic operators (e.g. `&&`, `||`) * logic operators (e.g. `&&`, `||`)
* comparison (e.g. `==`, `===`, `>`, `>=`, `<`, `<=`) * comparison (e.g. `==`, `===`, `>`, `>=`, `<`, `<=`)
@ -50,11 +50,11 @@ Don't use whitespace inside ANY parentheses (e.g. functions, loops, conditions,
```js ```js
for (let i = 1; i < 100; ++i) { ... } for (let i = 1; i < 100; ++i) { ... }
``` ```
```js ```js
function(para1, para2) { ... } function(para1, para2) { ... }
``` ```
### Brackets ### Brackets
@ -103,7 +103,7 @@ Always use a whitespace before the parentheses.
while (true) { while (true) {
... ...
} }
``` ```
## If, while, for, foreach, switch ## If, while, for, foreach, switch
@ -158,4 +158,18 @@ All string representations should use single quotes `''` unless `""` provides si
```js ```js
'This is a string' 'This is a string'
```
## Todos
Most issues should be documented in the code as todos and vice versa.
```php
/**
* @todo Orange-Management/Repository#IssueNumber
* Below comes the issue/todo description.
* This way developers can see todos directly in the code without going to an external source.
* Todos must not have empty lines in their descriptions.
* If the external ressources have empty lines they must be removed in the todo comment.
*/
``` ```