issue_workflow.md

stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/ee/development/development_processes.html#development-guidelines-review.

Issues workflow

Creating an issue

Before you submit an issue, search the issue tracker for similar entries. Someone else might have already had the same bug or feature proposal. If you find an existing issue, show your support with an emoji reaction and add your notes to the discussion.

Bugs

To submit a bug:

• Use the 'Bug' issue template. The text in the comments (<!-- ... -->) should help you with which information to include.
• To report a suspected security vulnerability, follow the disclosure process on the GitLab.com website.

WARNING: Do not create publicly viewable issues for suspected security vulnerabilities.

Feature proposals

To create a feature proposal, open an issue in the issue tracker using the Feature Proposal - detailed issue template.

In order to help track feature proposals, we use the ~"type::feature" label. Users that are not members of the project cannot add labels via the UI. Instead, use reactive label commands.

Keep feature proposals as small and simple as possible, complex ones might be edited to make them small and simple.

For changes to the user interface (UI), follow our design and UI guidelines, and include a visual example (screenshot, wireframe, or mockup). Such issues should be given the ~UX" label (using the reactive label commands) for the Product Design team to provide input and guidance.

Finding issues to work on

GitLab has over 75,000 issues that you can work on. You can use labels to filter and find suitable issues to work on. New contributors can look for issues with the quick win label.

The frontend and backend labels are also a good choice to refine the issue list.

Clarifying/validating an issue

Many issues have not been visited or validated recently. Before trying to solve an issue, take the following steps:

• Ask the author if the issue is still relevant.
• Ask the community if the issue is still relevant.
• Attempt to validate whether:
  • A merge request has already been created (see the related merge requests section). Sometimes the issue is not closed/updated.
  • The type::bug still exists (by recreating it).
  • The type::feature has not already been implemented (by trying it).

Working on the issue