2019-12-04 20:38:33 +05:30
# Issues workflow
2018-11-20 20:47:30 +05:30
2019-12-04 20:38:33 +05:30
## Issue tracker guidelines
**[Search the issue tracker](https://gitlab.com/gitlab-org/gitlab-foss/issues)** for similar entries before
submitting your own, there's a good chance somebody else had the same issue or
feature proposal. Show your support with an award emoji and/or join the
discussion.
Please submit bugs using the ['Bug' issue template ](https://gitlab.com/gitlab-org/gitlab/blob/master/.gitlab/issue_templates/Bug.md ) provided on the issue tracker.
The text in the parenthesis is there to help you with what to include. Omit it
when submitting the actual issue. You can copy-paste it and then edit as you
see fit.
## Issue triaging
Our issue triage policies are [described in our handbook ](https://about.gitlab.com/handbook/engineering/issue-triage/ ).
You are very welcome to help the GitLab team triage issues.
We also organize [issue bash events ](https://gitlab.com/gitlab-org/gitlab-foss/issues/17815 )
once every quarter.
The most important thing is making sure valid issues receive feedback from the
development team. Therefore the priority is mentioning developers that can help
on those issues. Please select someone with relevant experience from the
[GitLab team ](https://about.gitlab.com/team/ ).
If there is nobody mentioned with that expertise look in the commit history for
the affected files to find someone.
We also use [GitLab Triage ](https://gitlab.com/gitlab-org/gitlab-triage ) to
automate some triaging policies. This is currently set up as a
[scheduled pipeline ](https://gitlab.com/gitlab-org/quality/triage-ops/pipeline_schedules/10512/edit )
running on [quality/triage-ops ](https://gitlab.com/gitlab-org/quality/triage-ops ) project.
## Labels
To allow for asynchronous issue handling, we use [milestones ](https://gitlab.com/groups/gitlab-org/-/milestones )
and [labels ](https://gitlab.com/gitlab-org/gitlab-foss/-/labels ). Leads and product managers handle most of the
2018-11-20 20:47:30 +05:30
scheduling into milestones. Labelling is a task for everyone.
Most issues will have labels for at least one of the following:
2019-09-30 21:07:59 +05:30
- Type: ~feature, ~bug, ~backstage, etc.
- Stage: ~"devops::plan", ~"devops::create", etc.
2019-12-04 20:38:33 +05:30
- Group: ~"group::source code", ~"group::knowledge", ~"group::editor", etc.
- Category: ~"Category:Code Analytics", ~"Category:DevOps Score", ~"Category:Templates", etc.
- Feature: ~wiki, ~ldap, ~api, ~issues, ~"merge requests", etc.
2019-09-30 21:07:59 +05:30
- Department: ~UX, ~Quality
2019-12-04 20:38:33 +05:30
- Team: ~Documentation, ~Delivery
2019-09-30 21:07:59 +05:30
- Specialization: ~frontend, ~backend
2018-11-20 20:47:30 +05:30
- Release Scoping: ~Deliverable, ~Stretch, ~"Next Patch Release"
- Priority: ~P1, ~P2, ~P3, ~P4
- Severity: ~S1, ~S2, ~S3, ~S4
All labels, their meaning and priority are defined on the
2019-12-04 20:38:33 +05:30
[labels page ](https://gitlab.com/gitlab-org/gitlab-foss/-/labels ).
2018-11-20 20:47:30 +05:30
If you come across an issue that has none of these, and you're allowed to set
labels, you can _always_ add the team and type, and often also the subject.
2019-12-04 20:38:33 +05:30
### Type labels
2018-11-20 20:47:30 +05:30
Type labels are very important. They define what kind of issue this is. Every
2019-12-04 20:38:33 +05:30
issue should have one and only one.
The current type labels are:
2018-11-20 20:47:30 +05:30
2019-12-04 20:38:33 +05:30
- ~feature
- ~bug
- ~backstage
- ~"support request"
- ~meta
2018-11-20 20:47:30 +05:30
A number of type labels have a priority assigned to them, which automatically
makes them float to the top, depending on their importance.
Type labels are always lowercase, and can have any color, besides blue (which is
already reserved for subject labels).
2019-12-04 20:38:33 +05:30
The descriptions on the [labels page ](https://gitlab.com/groups/gitlab-org/-/labels )
explain what falls under each type label.
2018-11-20 20:47:30 +05:30
2019-12-04 20:38:33 +05:30
### Facet labels
2018-11-20 20:47:30 +05:30
2019-12-04 20:38:33 +05:30
Sometimes it's useful to refine the type of an issue. In those cases, you can
add facet labels.
2018-11-20 20:47:30 +05:30
2019-12-04 20:38:33 +05:30
Following is a non-exhaustive list of facet labels:
2019-09-30 21:07:59 +05:30
2019-12-04 20:38:33 +05:30
- ~enhancement: This label can refine an issue that has the ~feature label.
- ~"master:broken": This label can refine an issue that has the ~bug label.
- ~"master:flaky": This label can refine an issue that has the ~bug label.
- ~"technical debt": This label can refine an issue that has the ~backstage label.
- ~"static analysis": This label can refine an issue that has the ~backstage label.
- ~"ci-build": This label can refine an issue that has the ~backstage label.
- ~performance: A performance issue could describe a ~bug or a ~feature.
- ~security: A security issue could describe a ~bug or a ~feature.
- ~database: A database issue could describe a ~bug or a ~feature.
- ~customer: This relates to an issue that was created by a customer, or that is of interest for a customer.
2018-11-20 20:47:30 +05:30
2019-12-04 20:38:33 +05:30
### Stage labels
2018-11-20 20:47:30 +05:30
2019-12-04 20:38:33 +05:30
Stage labels specify which [stage ](https://about.gitlab.com/handbook/product/categories/#hierarchy ) the issue belongs to.
2018-11-20 20:47:30 +05:30
2019-12-04 20:38:33 +05:30
#### Naming and color convention
2019-09-30 21:07:59 +05:30
2019-12-04 20:38:33 +05:30
Stage labels respects the `devops::<stage_key>` naming convention.
`<stage_key>` is the stage key as it is in the single source of truth for stages at
< https: / / gitlab . com / gitlab-com / www-gitlab-com / blob / master / data / stages . yml >
with `_` replaced with a space.
2019-09-30 21:07:59 +05:30
2019-12-04 20:38:33 +05:30
For instance, the "Manage" stage is represented by the ~"devops::manage" label in
the `gitlab-org` group since its key under `stages` is `manage` .
2018-11-20 20:47:30 +05:30
2019-12-04 20:38:33 +05:30
The current stage labels can be found by [searching the labels list for `devops::` ](https://gitlab.com/groups/gitlab-org/-/labels?search=devops:: ).
2018-11-20 20:47:30 +05:30
2019-12-04 20:38:33 +05:30
These labels are [scoped labels ](../../user/project/labels.md#scoped-labels-premium )
and thus are mutually exclusive.
2018-12-13 13:39:08 +05:30
2019-12-04 20:38:33 +05:30
The Stage labels are used to generate the [direction pages ](https://about.gitlab.com/direction/ ) automatically.
2018-12-13 13:39:08 +05:30
2019-12-04 20:38:33 +05:30
### Group labels
2019-09-04 21:01:54 +05:30
2019-12-04 20:38:33 +05:30
Group labels specify which [groups ](https://about.gitlab.com/company/team/structure/#product-groups ) the issue belongs to.
2018-12-13 13:39:08 +05:30
2019-12-04 20:38:33 +05:30
It's highly recommended to add a group label, as it's used by our triage
automation to
[infer the correct stage label ](https://about.gitlab.com/handbook/engineering/quality/triage-operations/#auto-labelling-of-issues ).
2018-12-13 13:39:08 +05:30
2019-12-04 20:38:33 +05:30
#### Naming and color convention
2018-12-13 13:39:08 +05:30
2019-12-04 20:38:33 +05:30
Group labels respects the `group::<group_key>` naming convention and
their color is `#A8D695` .
`<group_key>` is the group key as it is in the single source of truth for groups at
< https: / / gitlab . com / gitlab-com / www-gitlab-com / blob / master / data / stages . yml > ,
with `_` replaced with a space.
2019-09-04 21:01:54 +05:30
2019-12-04 20:38:33 +05:30
For instance, the "Continuous Integration" group is represented by the
~"group::continuous integration" label in the `gitlab-org` group since its key
under `stages.manage.groups` is `continuous_integration` .
2019-09-04 21:01:54 +05:30
2019-12-04 20:38:33 +05:30
The current group labels can be found by [searching the labels list for `group::` ](https://gitlab.com/groups/gitlab-org/-/labels?search=group:: ).
2019-10-12 21:52:04 +05:30
2019-09-04 21:01:54 +05:30
These labels are [scoped labels ](../../user/project/labels.md#scoped-labels-premium )
and thus are mutually exclusive.
2019-12-04 20:38:33 +05:30
You can find the groups listed in the [Product Stages, Groups, and Categories ](https://about.gitlab.com/handbook/product/categories/ ) page.
2019-10-12 21:52:04 +05:30
2019-12-04 20:38:33 +05:30
We use the term group to map down product requirements from our product stages.
2019-10-12 21:52:04 +05:30
As a team needs some way to collect the work their members are planning to be assigned to, we use the `~group::` labels to do so.
Normally there is a 1:1 relationship between Stage labels and Group labels. In the spirit of "Everyone can contribute",
any issue can be picked up by any group, depending on current priorities. For example, an issue labeled ~"devops::create" may be picked up by the ~"group::access" group.
2019-12-04 20:38:33 +05:30
We also use stage and group labels to help quantify our [throughput ](https://about.gitlab.com/handbook/engineering/management/throughput ).
2019-10-12 21:52:04 +05:30
Please read [Stage and Group labels in Throughtput ](https://about.gitlab.com/handbook/engineering/management/throughput/#stage-and-group-labels-in-throughput ) for more information on how the labels are used in this context.
2019-09-04 21:01:54 +05:30
2019-12-04 20:38:33 +05:30
### Category labels
From the handbook's
[Product stages, groups, and categories ](https://about.gitlab.com/handbook/product/categories/#hierarchy )
page:
> Categories are high-level capabilities that may be a standalone product at
another company. e.g. Portfolio Management.
It's highly recommended to add a category label, as it's used by our triage
automation to
[infer the correct group and stage labels ](https://about.gitlab.com/handbook/engineering/quality/triage-operations/#auto-labelling-of-issues ).
If you are an expert in a particular area, it makes it easier to find issues to
work on. You can also subscribe to those labels to receive an email each time an
issue is labeled with a category label corresponding to your expertise.
#### Naming and color convention
Category labels respects the `Category:<Category Name>` naming convention and
their color is `#428BCA` .
`<Category Name>` is the category name as it is in the single source of truth for categories at
< https: / / gitlab . com / gitlab-com / www-gitlab-com / blob / master / data / categories . yml > .
For instance, the "Code Analytics" category is represented by the
~"Category:Code Analytics" label in the `gitlab-org` group since its
`code_analytics.name` value is "Code Analytics".
If a category's label doesn't respect this naming convention, it should be specified
with [the `label` attribute ](https://about.gitlab.com/handbook/marketing/website/#category-attributes )
in < https: / / gitlab . com / gitlab-com / www-gitlab-com / blob / master / data / categories . yml > .
### Feature labels
From the handbook's
[Product stages, groups, and categories ](https://about.gitlab.com/handbook/product/categories/#hierarchy )
page:
> Features: Small, discrete functionalities. e.g. Issue weights. Some common
features are listed within parentheses to facilitate finding responsible PMs by keyword.
It's highly recommended to add a feature label if no category label applies, as
it's used by our triage automation to
[infer the correct group and stage labels ](https://about.gitlab.com/handbook/engineering/quality/triage-operations/#auto-labelling-of-issues ).
If you are an expert in a particular area, it makes it easier to find issues to
work on. You can also subscribe to those labels to receive an email each time an
issue is labeled with a feature label corresponding to your expertise.
Examples of feature labels are ~wiki, ~ldap, ~api, ~issues, ~"merge requests" etc.
#### Naming and color convention
2019-09-04 21:01:54 +05:30
2019-12-04 20:38:33 +05:30
Feature labels are all-lowercase.
### Department labels
2019-09-30 21:07:59 +05:30
The current department labels are:
- ~UX
- ~Quality
2019-12-04 20:38:33 +05:30
### Team labels
**Important**: Most of the historical team labels (e.g. Manage, Plan etc.) are
now deprecated in favor of [Group labels ](#group-labels ) and [Stage labels ](#stage-labels ).
Team labels specify what team is responsible for this issue.
Assigning a team label makes sure issues get the attention of the appropriate
people.
The current team labels are:
- ~Delivery
- ~Documentation
#### Naming and color convention
Team labels are always capitalized so that they show up as the first label for
any issue.
### Specialization labels
2019-09-30 21:07:59 +05:30
These labels narrow the [specialization ](https://about.gitlab.com/company/team/structure/#specialist ) on a unit of work.
- ~frontend
- ~backend
2019-12-04 20:38:33 +05:30
### Release scoping labels
2018-11-20 20:47:30 +05:30
Release Scoping labels help us clearly communicate expectations of the work for the
release. There are three levels of Release Scoping labels:
- ~Deliverable: Issues that are expected to be delivered in the current
milestone.
- ~Stretch: Issues that are a stretch goal for delivering in the current
milestone. If these issues are not done in the current release, they will
strongly be considered for the next release.
- ~"Next Patch Release": Issues to put in the next patch release. Work on these
first, and add the "Pick Into X" label to the merge request, along with the
appropriate milestone.
Each issue scheduled for the current milestone should be labeled ~Deliverable
or ~"Stretch". Any open issue for a previous milestone should be labeled
~"Next Patch Release", or otherwise rescheduled to a different milestone.
2019-12-04 20:38:33 +05:30
#### Priority labels
2018-11-20 20:47:30 +05:30
Priority labels help us define the time a ~bug fix should be completed. Priority determines how quickly the defect turnaround time must be.
If there are multiple defects, the priority decides which defect has to be fixed immediately versus later.
2019-09-04 21:01:54 +05:30
This label documents the planned timeline & urgency which is used to measure against our target SLO on delivering ~bug fixes.
2018-11-20 20:47:30 +05:30
2019-09-04 21:01:54 +05:30
| Label | Meaning | Target SLO (applies only to ~bug and ~security defects) |
2018-12-13 13:39:08 +05:30
|-------|-----------------|----------------------------------------------------------------------------|
| ~P1 | Urgent Priority | The current release + potentially immediate hotfix to GitLab.com (30 days) |
| ~P2 | High Priority | The next release (60 days) |
| ~P3 | Medium Priority | Within the next 3 releases (approx one quarter or 90 days) |
| ~P4 | Low Priority | Anything outside the next 3 releases (more than one quarter or 120 days) |
2019-12-04 20:38:33 +05:30
### Severity labels
2018-11-20 20:47:30 +05:30
Severity labels help us clearly communicate the impact of a ~bug on users.
2019-09-30 21:07:59 +05:30
There can be multiple facets of the impact. The below is a guideline.
| Label | Meaning | Functionality | Affected Users | GitLab.com Availability | Performance Degradation |
|-------|-------------------|-------------------------------------------------------|----------------------------------|----------------------------------------------------|------------------------------|
| ~S1 | Blocker | Unusable feature with no workaround, user is blocked | Impacts 50% or more of users | Outage, Significant impact on all of GitLab.com | |
| ~S2 | Critical Severity | Broken Feature, workaround too complex & unacceptable | Impacts between 25%-50% of users | Significant impact on large portions of GitLab.com | Degradation is guaranteed to occur in the near future |
| ~S3 | Major Severity | Broken feature with an acceptable workaround | Impacts up to 25% of users | Limited impact on important portions of GitLab.com | Degradation is likely to occur in the near future |
| ~S4 | Low Severity | Functionality inconvenience or cosmetic issue | Impacts less than 5% of users | Minor impact on GitLab.com | Degradation _may_ occur but it's not likely |
If a bug seems to fall between two severity labels, assign it to the higher-severity label.
- Example(s) of ~S1
- Data corruption/loss.
- Security breach.
2019-10-12 21:52:04 +05:30
- Unable to create an issue or merge request.
2019-09-30 21:07:59 +05:30
- Unable to add a comment or thread to the issue or merge request.
- Example(s) of ~S2
- Cannot submit changes through the web IDE but the commandline works.
- A status widget on the merge request page is not working but information can be seen in the test pipeline page.
- Example(s) of ~S3
- Can create merge requests only from the Merge Requests list view, not from an Issue page.
- Status is not updated in real time and needs a page refresh.
- Example(s) of ~S4
- Label colors are incorrect.
- UI elements are not fully aligned.
2019-10-12 21:52:04 +05:30
2019-12-04 20:38:33 +05:30
### Label for community contributors
2018-11-20 20:47:30 +05:30
Issues that are beneficial to our users, 'nice to haves', that we currently do
not have the capacity for or want to give the priority to, are labeled as
2018-12-13 13:39:08 +05:30
~"Accepting merge requests", so the community can make a contribution.
2018-11-20 20:47:30 +05:30
Community contributors can submit merge requests for any issue they want, but
2018-12-13 13:39:08 +05:30
the ~"Accepting merge requests" label has a special meaning. It points to
2018-11-20 20:47:30 +05:30
changes that:
1. We already agreed on,
1. Are well-defined,
1. Are likely to get accepted by a maintainer.
We want to avoid a situation when a contributor picks an
2018-12-13 13:39:08 +05:30
~"Accepting merge requests" issue and then their merge request gets closed,
2018-11-20 20:47:30 +05:30
because we realize that it does not fit our vision, or we want to solve it in a
different way.
2018-12-13 13:39:08 +05:30
We add the ~"Accepting merge requests" label to:
2018-11-20 20:47:30 +05:30
- Low priority ~bug issues (i.e. we do not add it to the bugs that we want to
2019-07-07 11:18:12 +05:30
solve in the ~"Next Patch Release")
2019-03-02 22:35:43 +05:30
- Small ~feature
2018-11-20 20:47:30 +05:30
- Small ~"technical debt" issues
2018-12-13 13:39:08 +05:30
After adding the ~"Accepting merge requests" label, we try to estimate the
2018-11-20 20:47:30 +05:30
[weight ](#issue-weight ) of the issue. We use issue weight to let contributors
know how difficult the issue is. Additionally:
2019-12-04 20:38:33 +05:30
- We advertise [`Accepting merge requests` issues with weight < 5 ](https://gitlab.com/groups/gitlab-org/-/issues?state=opened&label_name[]=Accepting+merge+requests&assignee_id=None&sort=weight )
2018-11-20 20:47:30 +05:30
as suitable for people that have never contributed to GitLab before on the
[Up For Grabs campaign ](http://up-for-grabs.net )
- We encourage people that have never contributed to any open source project to
2019-12-04 20:38:33 +05:30
look for [`Accepting merge requests` issues with a weight of 1 ](https://gitlab.com/groups/gitlab-org/-/issues?state=opened&label_name[]=Accepting+merge+requests&assignee_id=None&sort=weight&weight=1 )
2018-11-20 20:47:30 +05:30
If you've decided that you would like to work on an issue, please @-mention
the [appropriate product manager ](https://about.gitlab.com/handbook/product/#who-to-talk-to-for-what )
as soon as possible. The product manager will then pull in appropriate GitLab team
members to further discuss scope, design, and technical considerations. This will
2018-12-05 23:21:45 +05:30
ensure that your contribution is aligned with the GitLab product and minimize
2018-11-20 20:47:30 +05:30
any rework and delay in getting it merged into master.
2018-12-13 13:39:08 +05:30
GitLab team members who apply the ~"Accepting merge requests" label to an issue
2018-11-20 20:47:30 +05:30
should update the issue description with a responsible product manager, inviting
any potential community contributor to @-mention per above.
2019-12-04 20:38:33 +05:30
### Stewardship label
2018-11-20 20:47:30 +05:30
2019-12-04 20:38:33 +05:30
For issues related to the open source stewardship of GitLab,
there is the ~"stewardship" label.
2018-11-20 20:47:30 +05:30
2019-12-04 20:38:33 +05:30
This label is to be used for issues in which the stewardship of GitLab
is a topic of discussion. For instance if GitLab Inc. is planning to add
features from GitLab EE to GitLab CE, related issues would be labelled with
~"stewardship".
2018-11-20 20:47:30 +05:30
2019-12-04 20:38:33 +05:30
A recent example of this was the issue for
[bringing the time tracking API to GitLab CE ](https://gitlab.com/gitlab-org/gitlab-foss/issues/25517#note_20019084 ).
2018-11-20 20:47:30 +05:30
2018-12-05 23:21:45 +05:30
## Feature proposals
2018-11-20 20:47:30 +05:30
To create a feature proposal for CE, open an issue on the
2019-12-04 20:38:33 +05:30
[issue tracker of CE ](https://gitlab.com/gitlab-org/gitlab-foss/issues ).
2018-11-20 20:47:30 +05:30
For feature proposals for EE, open an issue on the
2019-12-04 20:38:33 +05:30
[issue tracker of EE ](https://gitlab.com/gitlab-org/gitlab/issues ).
2018-11-20 20:47:30 +05:30
In order to help track the feature proposals, we have created a
2019-12-04 20:38:33 +05:30
[`feature` ](https://gitlab.com/gitlab-org/gitlab-foss/issues?label_name=feature ) label. For the time being, users that are not members
2019-09-30 21:07:59 +05:30
of the project cannot add labels. You can instead ask one of the [core team ](https://about.gitlab.com/community/core-team/ )
2019-03-02 22:35:43 +05:30
members to add the label ~feature to the issue or add the following
code snippet right after your description in a new line: `~feature` .
2018-11-20 20:47:30 +05:30
Please keep feature proposals as small and simple as possible, complex ones
might be edited to make them small and simple.
2019-12-04 20:38:33 +05:30
Please submit Feature Proposals using the ['Feature Proposal' issue template ](https://gitlab.com/gitlab-org/gitlab/blob/master/.gitlab/issue_templates/Feature%20proposal.md ) provided on the issue tracker.
2018-11-20 20:47:30 +05:30
For changes in the interface, it is helpful to include a mockup. Issues that add to, or change, the interface should
be given the ~"UX" label. This will allow the UX team to provide input and guidance. You may
2019-09-30 21:07:59 +05:30
need to ask one of the [core team ](https://about.gitlab.com/community/core-team/ ) members to add the label, if you do not have permissions to do it by yourself.
2018-11-20 20:47:30 +05:30
If you want to create something yourself, consider opening an issue first to
discuss whether it is interesting to include this in GitLab.
2018-12-05 23:21:45 +05:30
## Issue weight
2018-11-20 20:47:30 +05:30
Issue weight allows us to get an idea of the amount of work required to solve
one or multiple issues. This makes it possible to schedule work more accurately.
You are encouraged to set the weight of any issue. Following the guidelines
below will make it easy to manage this, without unnecessary overhead.
1. Set weight for any issue at the earliest possible convenience
1. If you don't agree with a set weight, discuss with other developers until
2019-07-07 11:18:12 +05:30
consensus is reached about the weight
2018-11-20 20:47:30 +05:30
1. Issue weights are an abstract measurement of complexity of the issue. Do not
2019-07-07 11:18:12 +05:30
relate issue weight directly to time. This is called [anchoring ](https://en.wikipedia.org/wiki/Anchoring )
and something you want to avoid.
2018-11-20 20:47:30 +05:30
1. Something that has a weight of 1 (or no weight) is really small and simple.
2019-07-07 11:18:12 +05:30
Something that is 9 is rewriting a large fundamental part of GitLab,
which might lead to many hard problems to solve. Changing some text in GitLab
is probably 1, adding a new Git Hook maybe 4 or 5, big features 7-9.
2018-11-20 20:47:30 +05:30
1. If something is very large, it should probably be split up in multiple
2019-07-07 11:18:12 +05:30
issues or chunks. You can simply not set the weight of a parent issue and set
weights to children issues.
2018-11-20 20:47:30 +05:30
2018-12-05 23:21:45 +05:30
## Regression issues
2018-11-20 20:47:30 +05:30
Every monthly release has a corresponding issue on the CE issue tracker to keep
track of functionality broken by that release and any fixes that need to be
included in a patch release (see [8.3 Regressions] as an example).
As outlined in the issue description, the intended workflow is to post one note
with a reference to an issue describing the regression, and then to update that
note with a reference to the merge request that fixes it as it becomes available.
If you're a contributor who doesn't have the required permissions to update
other users' notes, please post a new note with a reference to both the issue
and the merge request.
The release manager will [update the notes] in the regression issue as fixes are
addressed.
2019-12-04 20:38:33 +05:30
[8.3 Regressions]: https://gitlab.com/gitlab-org/gitlab-foss/issues/4127
2018-11-20 20:47:30 +05:30
[update the notes]: https://gitlab.com/gitlab-org/release-tools/blob/master/doc/pro-tips.md#update-the-regression-issue
2018-12-05 23:21:45 +05:30
## Technical and UX debt
2018-11-20 20:47:30 +05:30
In order to track things that can be improved in GitLab's codebase,
2019-12-04 20:38:33 +05:30
we use the ~"technical debt" label in [GitLab's issue tracker ](https://gitlab.com/gitlab-org/gitlab-foss/issues ).
2019-07-31 22:56:46 +05:30
For missed user experience requirements, we use the ~"UX debt" label.
2018-11-20 20:47:30 +05:30
These labels should be added to issues that describe things that can be improved,
shortcuts that have been taken, features that need additional attention, and all
other things that have been left behind due to high velocity of development.
For example, code that needs refactoring should use the ~"technical debt" label,
2019-07-31 22:56:46 +05:30
something that didn't ship according to our Design System guidelines should
use the ~"UX debt" label.
2018-11-20 20:47:30 +05:30
Everyone can create an issue, though you may need to ask for adding a specific
label, if you do not have permissions to do it by yourself. Additional labels
can be combined with these labels, to make it easier to schedule
the improvements for a release.
Issues tagged with these labels have the same priority like issues
that describe a new feature to be introduced in GitLab, and should be scheduled
for a release by the appropriate person.
Make sure to mention the merge request that the ~"technical debt" issue or
~"UX debt" issue is associated with in the description of the issue.
2018-12-13 13:39:08 +05:30
## Technical debt in follow-up issues
It's common to discover technical debt during development of a new feature. In
the spirit of "minimum viable change", resolution is often deferred to a
follow-up issue. However, this cannot be used as an excuse to merge poor-quality
code that would otherwise not pass review, or to overlook trivial matters that
don't deserve the be scheduled independently, and would be best resolved in the
original merge request - or not tracked at all!
The overheads of scheduling, and rate of change in the GitLab codebase, mean
that the cost of a trivial technical debt issue can quickly exceed the value of
tracking it. This generally means we should resolve these in the original merge
request - or simply not create a follow-up issue at all.
For example, a typo in a comment that is being copied between files is worth
fixing in the same MR, but not worth creating a follow-up issue for. Renaming a
method that is used in many places to make its intent slightly clearer may be
worth fixing, but it should not happen in the same MR, and is generally not
worth the overhead of having an issue of its own. These issues would invariably
be labelled `~P4 ~S4` if we were to create them.
More severe technical debt can have implications for development velocity. If
it isn't addressed in a timely manner, the codebase becomes needlessly difficult
to change, new features become difficult to add, and regressions abound.
Discoveries of this kind of technical debt should be treated seriously, and
while resolution in a follow-up issue may be appropriate, maintainers should
generally obtain a scheduling commitment from the author of the original MR, or
the engineering or product manager for the relevant area. This may take the form
of appropriate Priority / Severity labels on the issue, or an explicit milestone
and assignee.
The maintainer must always agree before an outstanding discussion is resolved in
this manner, and will be the one to create the issue. The title and description
should be of the same quality as those created
[in the usual manner ](#technical-and-ux-debt ) - in particular, the issue title
**must not** begin with `Follow-up` ! The creating maintainer should also expect
to be involved in some capacity when work begins on the follow-up issue.
2018-11-20 20:47:30 +05:30
---
[Return to Contributing documentation ](index.md )
