/builds/gitlab-kitware-sciviz-ci/Documentation/dev/git/labels.md
Go to the documentation of this file.
1 Labels
2 ======
3 
4 [Labels][] are used to annotate [Issues][] and [Merge Requests][]. They help
5 organize and provide information about their state in the development
6 workflow.
7 
8 Labels are named using the form `[category]:[name]`. Labels in the same category
9 has the same color.
10 
11 `area:...`
12 ------------
13 
14 Labels in this category identify a component of ParaView affected by the issue.
15 Current list includes `area:catalyst`, `area:doc`, `area:packaging`, `area:third-party`,
16 and `area:web`.
17 
18 Reporters and developers can assign these labels to an issue to help organize.
19 
20 `priority:...`
21 --------------
22 
23 An issue gets assigned a **Milestone** to indicate which release a fix for it
24 is planned for. The `priority:...` label can be used to indicate how critical is
25 this issue for that milestone.
26 
27 
28 | label | issues | merge requests | description |
29 | ----- | -------| -------------- | ----------- |
30 | `priority:required` | x | | issue is **required** for a milestone (highest priority) |
31 | `priority:important` | x | | issue is **important** for a milestone but may be okay if missed |
32 | `priority:nice-to-have` | x | | issue is **nice-to-have**, but not critical or important |
33 | `priority:low` | x | | low priority issues for a particular milestone |
34 
35 If an issue targeted for a milestone has no priority label, then it is assumed
36 the least priority.
37 
38 `project:...`
39 ---------------
40 
41 These labels are associated with Issues to identify the project/customer that
42 wants the issue addressed. Project manager and developers working with their
43 managers can use these labels to denote the stakeholders for a particular issue.
44 
45 `triage:...`
46 --------------
47 
48 These labels can be assigned to Issues and Merge Requests to help triage as
49 indicated in the table below:
50 
51 | label | issues | merge requests | description |
52 | ----- | -------| -------------- | ----------- |
53 | `triage:confirmed` | x | | issue has been confirmed by someone other than the reporter |
54 | `triage:easy` | x | | added by developers to issues that are easy to fix |
55 | `triage:expired` | x | x | added to issues closed without resolving or merge requests closed without merging due to lack of activity |
56 | `triage:feature` | x | | issue is a feature request; can be added by developers or reporters |
57 | `triage:needinfo` | x | x | on an open issue, this label is added to indicate that more information is needed from the reporter; on a closed issue, this label is added to indicate that more information is needed from the developer who closed the issue about how to test or review the issue; on a merge request this label is added to request more information from the developer before the merge request can be reviewed |
58 | `triage:needswork` | | x | added to merge requests after review if the reviewer deems it needs more work before it can be merged |
59 | `triage:pending-dashboards` | | x | added to merge requests that are awaiting dashboards before they can be reviewed or merged |
60 | `triage:ready-for-review` | | x | added to merge requests that are ready for review by a developer |
61 
62 These labels may be removed if the issue or merge request is no longer in the
63 state indicated by the label. For example, a merge request gets a `triage:ready-for-review`
64 label to request another developer to review it. If the reviewer deems it needs
65 more work, he should add the `triage:needswork` label and remove the `triage:ready-for-review`
66 label since the latter is no longer applicable.
67 
68 `workflow:...`
69 --------------
70 
71 These labels are added to issues to indicate their state in the development cycle.
72 Similar to `priority:...`, there can only be at most one workflow label on an issue
73 at a time.
74 
75 | label | issues | merge requests | description |
76 | ----- | -------| -------------- | ----------- |
77 | `workflow:active-developement` | x | | added to an open issue that is under development |
78 | `workflow:customer-review` | x | | added to a closed issue that is ready for review by the customer/reporter |
79 
80 [Labels]: https://gitlab.kitware.com/paraview/paraview/-/labels
81 [Issues]: https://gitlab.kitware.com/paraview/paraview/-/issues
82 [Merge Requests]: https://gitlab.kitware.com/paraview/paraview/-/merge_requests