cli/docs/triaging_bugs.md

2.0 KiB

stage group info
Create Code Review 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:

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 in the GitLab engineering handbook.