mirror of
https://github.com/Karaka-Management/Developer-Guide.git
synced 2026-02-02 14:18:39 +00:00
add todo/issue policy
This commit is contained in:
parent
c42d3e8abd
commit
9063b57530
|
|
@ -159,3 +159,17 @@ 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.
|
||||||
|
*/
|
||||||
|
```
|
||||||
Loading…
Reference in New Issue
Block a user