Using Labels
Labels are a highly useful feature of GitHub that allows for metadata to be appended to projects, issues, pull requests, and so forth. Rubrik makes heavy use of labels in order to drive automated tasks and express intent.
Labels will be structured in the following manner:
label_major-label_minor
The labels available are as follows:
Major | Minor | Description & Color Code | Type |
---|---|---|---|
area |
rcdm polaris partner |
The functional area. #84b6eb |
Issue |
exp |
beginner intermediate expert |
The expertise necessary. #ffc5a8 |
Issue |
good first issue |
n/a | Indicates an Issue that is reserved for a complete novice user. #51ef63 |
Issue |
help wanted |
n/a | Indicates a need for investment. #159818 |
Issue |
kind |
bug docs enhancement experimental feature question |
Indicates the type of Issue. #b5152d |
Issue |
platform |
windows linux mac |
Indicates a platform requirement or association. #cccccc |
Issue |
priority |
p0 p1 p2 p3 |
Indicates the priority level when determining where to invest effort. All customer specific requests should be marked as p0. #fbca04 |
Issue |
roadmap |
n/a | Indicates an item that will be addressed in the future roadmap. #0b008c |
Issue |
resolution |
answered by-design duplicate external fixed won’t-fix |
Indicates the status of the issue. #ffdddd |
Issue |
status |
failing-ci more-info-needed needs-attention needs-vendoring 0-triage 1-design-review 2-code-review 3-docs-review 4-merge |
Indicates the status of the PR. #006b75 & #004b75 |
PR |
version |
master {versions} |
Indicates the affected version. #b2482a |
Issue |
Example 1
An Issue is submitted that requires a bug fix to one of our SDK projects. It’s not easy enough for a first time developer to fix, but also doesn’t require expert level expertise. After reviewing the bug with the team, we determine it’s a P1 priority.
- Issue Labels: kind-bug, exp-intermediate, priority-p1
- PR Labels: status-* (handled by CI tool)
Example 2
An Issue is submitted that highlights a broken link in our documentation. It’s a trivial fix to perform and affects those using a Windows desktop machine.
- Issue Labels: kind-docs, platform-windows
- PR Labels: status-* (handled by CI tool)