add todo/issue policy

This commit is contained in:
Dennis Eichhorn 2020-01-05 21:38:23 +01:00
parent c42d3e8abd
commit 9063b57530

View File

@ -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.
*/
```