add issue information

This commit is contained in:
Dennis Eichhorn 2020-05-22 17:31:23 +02:00
parent b956e6f1b7
commit 61b93762f6

View File

@ -197,7 +197,7 @@ Most issues should be documented in the code as todo and vice versa.
```php
/**
* @todo Orange-Management/Repository#IssueNumber
* @todo Orange-Management/Repository#IssueNumber [issue:information]
* 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.
@ -205,4 +205,54 @@ Most issues should be documented in the code as todo and vice versa.
* 1. list item 1
* 2. list item 2
*/
```
```
The issue information can be used to provide additional information such as priority, difficulty and type.
### Priority
Structure:
```php
[p:{PRIORITY}]
```
Possible priorities are:
* high
* low
* medium
### Difficulty
Structure:
```php
[d:{DIFFICULTY}]
```
Possible difficulties are:
* first
* beginner
* expert
* medium
Difficulties marked with first are perfect for people who would like to contribute to the project for the first time.
### Type
Structure:
```php
[t:{TYPE}]
```
Possible types are:
* feature
* optimization
* performance
* question
* security
* todo (= default)