Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit c56bd0d

Browse files
doboothkeharper
andauthored
Apply suggestions from code review
Co-authored-by: Kevin Harper <keharper@users.noreply.github.com>
1 parent ceeb33d commit c56bd0d

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

src/contributor-guide/processing-workflow.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
group: contributor-guide
3-
title: Github Issue Processing Workflow
3+
title: GitHub issue processing workflow
44
---
55

66
The Github issue workflow ensures that issues are clear, well written, and thoroughly vetted. Following these procedures allows valid issues to get the attention they deserve.
@@ -18,15 +18,15 @@ Issue gates are a series of steps that are run to make sure the issue has all th
1818

1919
### Gate 1 - Verification of the report format
2020

21-
The main goal of this initial verification stage is to be sure that report has well-structured content according to the requirements from [Issue Reporting Guidelines](contributing.html#report). This stage looks trivial and formal but it will definitely affect processing speed. Generally, an issue that has the expected structure and clear information will be processed faster than the same report with a poor format.
21+
The main goal of this initial verification stage is to be sure that the report has well-structured content that meets the requirements from [Issue Reporting Guidelines](contributing.html#report). This stage looks trivial and formal, but it will definitely affect processing speed. Generally, an issue that has the expected structure and clear information will be processed faster than the same report with a poor format.
2222
The reported issue must contain **all** the following keywords in the description section:
2323

2424
* _Preconditions_
2525
* _Steps to Reproduce_
2626
* _Actual Result_
2727
* _Expected Result_
2828

29-
A maintainer can request the reporter to update the issue description and provide additional information. The `Issue: needs update` label will be added. A reporter has 14 days to update the issue description; otherwise, the issue will be closed. The maintainer may update the issue description format if sufficient information is provided.
29+
A maintainer can request the reporter to update the issue description and provide additional information. The maintainer will add the `Issue: needs update` label. A reporter has 14 days to update the issue description; otherwise, the issue will be closed. The maintainer may update the issue description format if sufficient information is provided.
3030

3131
### Gate 2 - Manual verification
3232

@@ -37,9 +37,9 @@ Working on an issue report as a reporter, maintainer, or developer is always a c
3737

3838
#### Preparation
3939

40-
These are steps for reviewing the issue, verifying reproduction steps, and assigning a Maintainer to work it.
40+
These are steps for reviewing the issue, verifying reproduction steps, and assigning a maintainer to work it.
4141

42-
1. A maintainer selects a ticket from the GitHub tracker which is not yet processed. The recommended tool is the [Issue Confirmation and Triage Board](https://github.com/magento/magento2/projects/23).
42+
1. A maintainer selects an unprocessed ticket from the GitHub tracker. The recommended tool is the [Issue Confirmation and Triage Board](https://github.com/magento/magento2/projects/23).
4343
1. The maintainer reviews the list from the "Ready for Confirmation" column and selects an issue to begin processing.
4444
1. After selecting the ticket, the maintainer checks the description and reproduction steps.
4545
1. When the maintainer is ready to start processing the issue, the maintainer should assign the ticket to him/her self. This indicates someone is actively working on the issue.
@@ -84,7 +84,7 @@ Steps for final review of an issue for contributors/developers to work the issue
8484

8585
1. Add the label `Issue: Confirmed` to the ticket.
8686
1. Wait for a response from the Automated Contributor Assistant, which normally takes 30-60 seconds.
87-
1. If all required information was provided Automated Contributor Assistant will comment with reference ticket numbers and link in the internal backlog. Otherwise, the label `Issue: Confirmed` will be removed and information on what is missing in the report will be provided to the maintainer.
87+
1. If all required information was provided, the Automated Contributor Assistant will comment with reference ticket numbers and a link in the internal backlog. Otherwise, the label `Issue: Confirmed` will be removed, and information on what is missing in the report will be provided to the maintainer.
8888
1. Un-assign the ticket from yourself so that developers can claim the issue and start development.
8989

9090
If the issue was reproduced on `Gate 3`, we will create an internal `AC-XXXX` ticket to track the progress of the issue.
@@ -102,21 +102,21 @@ After triage, either Magento core developers or Magento community developers may
102102

103103
The following terms help define the process:
104104

105-
* `Reporter`User who filed initial issue report.
106-
* `Maintainer`User a member of Community Maintainers Team who is and working on the issue report to update and confirm report in accordance with all requirements.
105+
* `Reporter`The user who filed the initial issue report.
106+
* `Maintainer`A member of Community Maintainers Team who is working on the issue report to update and confirm report in accordance with all requirements.
107107
* `Automated Contributor Assistant` – Non-human users/bots that perform automatic checks and provide assistance to human users.
108-
* `Label` – GitHub label applied to the ticket.
108+
* `Label`The GitHub label applied to the ticket.
109109

110110
Label descriptions:
111111

112-
* `Issue: Confirmed`Label assigned when the Maintainer reproduced the issue using the latest `2.4-develop` branch.
113-
* `Issue: Cannot reproduce`Label assigned when the described issue is not reproducible by the described scenario or reproduction steps.
114-
* `non-issue`Label assigned when the described behavior in the report is correct, expected behavior, and not an issue.
115-
* `Area: xxx`Labels indicating Magento Open Source functional area that may be the origin of the issue. There is a specific label for each major area.
116-
* `Reproduced on 2.4.x` - Label indicating the release line where the Maintainer can reproduce the issue.
117-
* `Issue: needs update`Label indicating that the issue is pending a response from the reporter.
118-
* `Reported on 2.x.x` - Label indicating original Magento Open Source version for the Issue report.
112+
* `Issue: Confirmed`The maintainer has reproduced the issue using the latest `2.4-develop` branch.
113+
* `Issue: Cannot reproduce`The described issue is not reproducible by the described scenario or reproduction steps.
114+
* `non-issue`The described behavior in the report is correct or expected behavior, and is not an issue.
115+
* `Area: xxx`The {{site.data.var.ce}} functional area that might be the origin of the issue. There is a specific label for each major area.
116+
* `Reproduced on 2.4.x` - The release line where the maintainer reproduced the issue.
117+
* `Issue: needs update`The issue is pending a response from the reporter.
118+
* `Reported on 2.x.x` - The original {{site.data.var.ce}} version for the issue report.
119119

120120
## Questions and Discussion
121121

122-
If you have any questions, feedback, or proposals for this workflow, please join the [Community Engineering Slack Workspace](https://opensource.magento.com/slack). We have a [#backlog-maintainers](https://magentocommeng.slack.com/messages/CCV2S9P7S) channel specifically for these discussions.
122+
If you have any questions, feedback, or proposals for this workflow, join the [Community Engineering Slack Workspace](https://opensource.magento.com/slack). We have a [#backlog-maintainers](https://magentocommeng.slack.com/messages/CCV2S9P7S) channel specifically for these discussions.

0 commit comments

Comments
 (0)