Clean up Engineering Workflow Label Guidance
Why is this change being made?
The Engineering Workflow page has multiple references to the use of Workflow labels at various locations around the page. Some of these omit the new requirement to add the workflowcomplete label which results, among other things, in inaccurate reporting of completed work through linked issue lists in the monthly release post. There is also some duplication between these sections.
This MR makes a number of small changes that should improve discoverability and adherence to label workflow during the build phase:
- Adds the workflowcomplete label process to the "Basics" section.
- Consolidates the Updating Issues Throughout Development and Workflow Labels sections into an "Updating Workflow Labels Throughout Development" section.
- Places this section under "Basics", as it expands upon the use of workflow labels summarized in that section.
- Replaces a link to the contribution guide, which no longer has information on labels, with one to development documentation specifically listing workflow labels.
Author Checklist
-
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
- If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the
-
If the changes affect team members, or warrant an announcement in another way, please consider posting an update in #whats-happening-at-gitlab linking to this MR - If this is a change that directly impacts the majority of global team members, it should be a candidate for #company-fyi. Please work with internal communications and check the handbook for examples.
Edited by Wayne Haber