Skip to content

Reintroduce Guidance on Regressions and ~regression label use

John Hope requested to merge jh-return-regression-guidance-to-handbook into master

Why is this change being made?

Five years ago @meks put a lot of work went into gitlab-org/gitlab-foss#48518 (closed) to ensure Regression guidance was clearly documented.

There was a lot of debate in the original MR ( gitlab-org/gitlab-foss!20623 (merged)) and issue, and a lot of effort went into getting the guidance right. There was even a chart to track the number of regressions ( gitlab-org/gitlab-foss#48518 (comment 87989940)).

I recently realized that, in Plan at least, we have very little visibility over the number and severity of regressions that occur. Moreover, the original authors and reviewers of an MR that introduced a regression often aren't even aware that it was reverted, so nothing is learned.

This resulted in the RCA Experiment in Plan.

As part of a Q3 OKR, I'd like to reintroduce guidance on the use of the ~regression label(s) so that, with consistent use, we can reliably chart the number of regressions we're producing and take action to keep it low.

This change starts by simply reintroducing the old guidance (though in a new location) and then building on that.

Author and Reviewer Checklist

Please verify the check list and ensure to tick them off before the MR is merged.

  • Provided a concise title for this Merge Request (MR)
  • Added a description to this MR explaining the reasons for the proposed change, per say why, not just what
    • Copy/paste the Slack conversation to document it for later, or upload screenshots. Verify that no confidential data is added, and the content is SAFE
  • Assign reviewers for this MR to the correct Directly Responsible Individual/s (DRI)
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the Maintained by section on the page being edited
    • If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies
    • The when to get approval handbook section explains the workflow in more detail
  • For transparency, share this MR with the audience that will be impacted.
    • Team: For changes that affect your direct team, share in your group Slack channel
    • Department: If the update affects your department, share the MR in your department Slack channel
    • Company: If the update affects all (or the majority of) GitLab team members, post an update in #whats-happening-at-gitlab linking to this MR

Merge request reports