Labels
Topics
Status Labels
These labels are used to indicate the state of a pull request.
| Label | Description | Who |
|---|---|---|
code-review | Status: requires a code review. | Added by the pull request submitter. Removed by code reviewer. |
hold | Status: on hold–do not proceed with other status items. | Confirm with your team before removing, specially with the person who added the label. |
in-qa | Status: requires QA before merging. | Added by the code reviewer. Removed when merge label is added or if fails QA. |
merge | Status: ready to merge. | Added by the reviewer or the person who did the QA. |
Review Labels
These labels indicate there is some action that needs to be taken by the person that has submitted the Pull Request. Typically, the code reviewer will add these labels to the Pull Request and, the person who has submitted the Pull Request removes them.
| Label | Description | Who |
|---|---|---|
bug | Contains a bug that needs resolution. | Added by the code reviewer. Removed once the bug is resolved. |
enhance | Code could use some enhancements before merging. | Added by the code reviewer. Removed if the enhancement is done or it is agreed that it should not be done. |
needs artifact | A screencast, screenshot, or other artifact is needed before merging. | Added by code reviewer. |
needs changelog | Needs a changelog entry before merging. | Added by code reviewer. |
needs release | Needs an associated release in Jira before merging. | Added by code reviewer. |
needs tests | Needs tests before merging. | Added by code reviewer. |
needs ticket | Needs an associated Jira ticket before merging. | Added by code reviewer. |
question | Needs an answer to one or more questions before merging. | Typically assigned to the person that can answer the question. Typically removed by the person who answers the question. |
translation | Has translation issues that need to be resolved before merging. | Added by code reviewer. |