File: triaging_bugs.md

package info (click to toggle)
glab 1.53.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 20,936 kB
  • sloc: sh: 295; makefile: 153; perl: 99; ruby: 68; javascript: 67
file content (48 lines) | stat: -rw-r--r-- 2,125 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
---
stage: Create
group: Code Review
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
---

# Create a bug in the glab project

Any contributor can raise bugs against the `glab` CLI project. Use the appropriate
issue template for your bug:

- For potential security vulnerabilities, create an issue
  [with the **Vulnerability Disclosure** template](https://gitlab.com/gitlab-org/cli/-/issues/new?issuable_template=Vulnerability%20Disclosure). This template creates a confidential issue.
- For all other bugs, create an issue [with the **Bug** template](https://gitlab.com/gitlab-org/cli/-/issues/new?issuable_template=Bug).

## Add labels to your bug

The issue templates help set the correct labels for your bug. Add any of these
labels that are also appropriate to your bug:

- `~"bug::performance"`: For bugs about the response time of `glab`.
- `~UX`: For user experience problems.

## Triage your bug

Use this guide to assign a severity label to your bug. A severity label helps the
`glab` CLI project team prioritize fixes. This project uses the same severity
guidelines as the wider GitLab organization. Use these `glab`-specific examples
to help you assess the problem:

- `~"severity::1"`: Blocker. A security vulnerability that requires an immediate fix.
- `~"severity::2"`: Critical.
  - All `glab` commands fail, even when the target GitLab instance is working as expected.
  - A security vulnerability with a fix needed for next release.
- `~"severity::3"`: Major.
  - A command fails with no workaround.
  - A command fails with an unexpected error.
  - The command output is incorrect.
  - The documentation is inaccurate.
- `~"severity::4"`: Low.
  - A cosmetic bug.
  - The command output could be improved.
  - The command fails, but a suitable workaround exists.
  - A documentation improvement.

For full details, see
[Severity](https://handbook.gitlab.com/handbook/engineering/infrastructure/engineering-productivity/issue-triage/#severity)
in the GitLab engineering handbook.