Keywords are used to tag issues to retrieve them by queries. For instance we use the keywords of the category Breaking Tags to generate a report informing about API and runtime changes.
We deem the following keywords useful.
Tags providing information about the system.
| Keyword | Description |
|---|---|
| info.internalTask | Issues that are tasks that will not be shown in any report. It is expected that there is either a info.overview parent for this issue or this issue is simply not expected to be displayed to anyone. |
| info.noteworthy | Identifies an issue for the "New and Noteworthy" report. |
| info.overview | The issue contains useful information and may group sub issues. It is expected that these issues contain high quality information to be presented in release reports. |
Issues tagged with following keywords will be reported on in "Documentation Requirement Report". On the release, this report should show no items. So the report is relevant during development time while working on the snapshot.
| Keyword | Description |
|---|---|
| remember.architecture | The issue contains information about an architectural decision (adding new technology, etc.) to be documented. |
| remember.convention | The issue contains information about a convention decision to be documented. |
| remember.design | The issue contains information about a design decision to be documented. |
Tags define that the issue is about to be worked on or if it cannot be worked on. Reports on this tags will reveal problems not ready to be solved. The whiteboard may reveal further information.
| Keyword | Description |
|---|---|
| status.crossProject | Issues that involve multiple projects. |
| status.discussion | The bug/feature is in discussion. Maybe it will be fixed/implemented or not. |
| status.investigate | Used to flag bug reports or feature requests that need to be investigated before they can be commited to. |
| status.needinfo | Need more information - incomplete bug report. This also includes requesting information on requirements or questions to the customer. |
| status.patched | There is a patch for the issue but the code is not part of the repository yet. |
This tags are used to show changes in the release notes that break behavior of the previous release.
| Keyword | Description |
|---|---|
| break.api | Issues that require API changes. |
| break.deprecated | Issues that deprecate parts of the code to be removed in later versions. |
| break.removed | Issues that remove features from the code. |
| break.runtime | Issues that change the runtime behavior of the code. |
Tags to qualify the concern of the issue in respect of the code.
| Keyword | Description |
|---|---|
| code.accessibility | Issues related to accessibility. |
| code.config | Issues related to the configuration or infrastructure of the project. This includes changes to the build files or required configuration on build servers for this project. |
| code.core | Issues related to non-UI components. |
| code.documentation | Issues related to wrong, misguiding or missing documentation. |
| code.performance | Issues related to performance. |
| code.quality | Issues dealing with refactorings to improve code quality in respect to expressiveness, scalability and maintainability. |
| code.security | Issues related to security. |
| code.test | Issues related to test cases or infrastructure. |
| code.ui | Issues related to UI components. |
| code.usability | Issues related to usability. |