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

Commit f70cfd3

Browse files
committed
Merge branch 'master' of github.com:magento-commerce/devdocs into update_uct_errors_references
2 parents ec6eefa + ce18ee2 commit f70cfd3

File tree

12 files changed

+185
-55
lines changed

12 files changed

+185
-55
lines changed

src/_data/toc/contributor-guide.yml

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,25 @@ pages:
66
versionless: true
77

88
children:
9-
- label: Commerce Definition of Done
10-
url: /contributor-guide/contributing_dod.html
11-
versionless: true
12-
139
- label: Backward compatible development
1410
url: /contributor-guide/backward-compatible-development/
1511
versionless: true
12+
13+
- label: Commerce Definition of Done
14+
url: /contributor-guide/contributing_dod.html
15+
versionless: true
1616

17-
- label: Pull Request Tests
18-
url: /contributor-guide/pull-request-tests.html
17+
- label: GitHub issue processing workflow
18+
url: /contributor-guide/processing-workflow.html
1919
versionless: true
2020

2121
- label: PHPStorm plugin code inspections
2222
url: /contributor-guide/phpstorm-code-inspections.html
2323
versionless: true
24+
25+
- label: Pull request tests
26+
url: /contributor-guide/pull-request-tests.html
27+
versionless: true
2428

2529
- label: Docs Contributions
2630
children:
Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
---
2+
group: contributor-guide
3+
title: GitHub issue processing workflow
4+
---
5+
6+
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.
7+
8+
Issues that are reported on the public [GitHub](https://github.com/magento/magento2/issues) must pass through a series of gates, or stages of quality assessment, to ensure that their quality meets our standards. There are three gates, and an issue must pass through all three of these assessments before we will transfer it to either core developers or community developers.
9+
The purpose of these gates is to identify core technical issues common to all reported tickets, and to show the progress on each reported issue.
10+
11+
## Issue Gates
12+
13+
Issue gates are a series of steps that are run to make sure the issue has all the information needed to reproduce the bug. This includes system configurations, required configurations, reproduction steps and any other required information.
14+
15+
* Gate 1: Verification of the report format - ensures that report content and structure meet all of our requirements.
16+
* Gate 2: Manual verification - Someone manually confirms that all necessary information has been provided: steps to reproduce, system configs, etc.
17+
* Gate 3: Reproduce the bug - Someone sets up an environment and tries to reproduce the bug. The issue is then confirmed or closed.
18+
19+
### Gate 1 - Verification of the report format
20+
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.
22+
The reported issue must contain **all** the following keywords in the description section:
23+
24+
* _Preconditions_
25+
* _Steps to Reproduce_
26+
* _Actual Result_
27+
* _Expected Result_
28+
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.
30+
31+
### Gate 2 - Manual verification
32+
33+
Gate 2 verifies a submitted issue is ready for development.
34+
By the end of the process, it has been vetted for development including all labels for Functional Areas, Affected Versions, and so on. The reproduction steps are correct and the reported issue is a defect that should be fixed and not due to misuse or a misconfiguration.
35+
36+
Working on an issue report as a reporter, maintainer, or developer is always a commitment. It is beneficial for every participating party to monitor activity and comments on the ticket during its lifetime, and provide any needed information or insights.
37+
38+
#### Preparation
39+
40+
These are steps for reviewing the issue, verifying reproduction steps, and assigning a maintainer to work it.
41+
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).
43+
1. The maintainer reviews the list from the "Ready for Confirmation" column and selects an issue to begin processing.
44+
1. After selecting the ticket, the maintainer checks the description and reproduction steps.
45+
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.
46+
47+
#### Validation
48+
49+
These are the steps for validating the issue format and all information provided checks out:
50+
51+
1. When the issue is entered, verify that it meets all requirements from the [templates](https://github.com/magento/magento2/tree/2.4-develop/.github/ISSUE_TEMPLATE) and [Issue Reporting Guidelines](contributing.html#report).
52+
1. If the format is not valid, the maintainer should read the report carefully and edit the issue to better match one of the required [templates](https://github.com/magento/magento2/tree/2.4-develop/.github/ISSUE_TEMPLATE).
53+
1. The maintainer can select the issue and review all information, reproduction steps, etc. If the information is incomplete, the maintainer requests more information from the reporter and applies the label `Issue: needs update`. All work pauses on this ticket until the reporter provides more information.
54+
1. If the ticket has enough information, the maintainer analyzes the problem described in the ticket: described steps to reproduce are valid, expected behavior is valid, the configuration described in preconditions is valid.
55+
1. Is it validated?
56+
57+
* If all provided information is clear and sufficient, it is validated.
58+
* If it is not validated, the maintainer adds the label `Issue: needs update` and requests more information from the reporter.
59+
60+
### Gate 3: Reproduce the issue
61+
62+
In gate 3, the issue is reproduced in the code.
63+
Currently, we only accept pull requests for the `2.4-develop` branch.
64+
65+
1. The maintainer checks if the issue exists on the `2.4-develop` branch with a clean installation, configured by the described preconditions, and following the exact reproduction steps.
66+
67+
* If the described behavior **is** reproduced, the maintainer should apply the `Reproduced on 2.4` label to the ticket, indicating that issue was reproduced and specific version.
68+
* If the issue **is not** reproducible on `2.4-develop`, the maintainer should close the issue and **stop the verification process here**.
69+
70+
1. If the steps required to reproduce the issue are different from the initially described reproduction steps, update the ticket description with the actual steps.
71+
1. Based on the verification flow, add only one `Area: xxx` label to the issue. Use your best judgment to determine the functional area affected.
72+
1. (optional if possible) Based on the original issue report add one `Reported on: XXX` label to indicate the original Open Source version for the Issue report.
73+
74+
## Finalization
75+
76+
Steps for final review of an issue for contributors/developers to work the issue.
77+
78+
1. Please make sure that all required conditions are met:
79+
* [ ] Issue format is valid.
80+
* [ ] Issue is reproducible with one of the supported versions and labeled appropriately.
81+
* [ ] `Area: XXX` is label applied to the ticket.
82+
* [ ] (optional if possible) `Reported on: XXX` label is applied to the ticket.
83+
* [ ] (optional if possible) `Severity: XX` label is applied to the ticket. See more in [Community Backlog Priority](contributing.html#backlog)
84+
85+
1. Add the label `Issue: Confirmed` to the ticket.
86+
1. Wait for a response from the Automated Contributor Assistant, which normally takes 30-60 seconds.
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.
88+
1. Un-assign the ticket from yourself so that developers can claim the issue and start development.
89+
90+
If the issue was reproduced on `Gate 3`, we will create an internal `AC-XXXX` ticket to track the progress of the issue.
91+
92+
Once an issue has been acknowledged and confirmed, it goes through the Triage Process and be [prioritized(triaged)](contributing.html#backlog).
93+
After triage, either core developers or community developers may fix it. We encourage everyone to join the Community Contribution Team and submit Pull Request with the bug fix to [magento/magento2](https://github.com/magento/magento2/pulls) repository.
94+
95+
## Tips and tricks
96+
97+
* If you need a proper testing environment, a verification instance with limited capabilities may be [requested](contributing.html#vanilla-pr) from the Automated Contributor Assistant.
98+
* In most cases, we do not recommend verifying issues on older patch versions, even if it was supplied in the preconditions. Generally, fixes can only be provided with the next patch version, and not with any of the older patches.
99+
* Always follow the [Code of Conduct](https://github.com/magento/magento2/blob/2.4-develop/.github/CODE_OF_CONDUCT.md) in issue comments and discussions.
100+
101+
## Glossary
102+
103+
The following terms help define the process:
104+
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.
107+
* `Automated Contributor Assistant` – Non-human users/bots that perform automatic checks and provide assistance to human users.
108+
* `Label` – The GitHub label applied to the ticket.
109+
110+
Label descriptions:
111+
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.
119+
120+
## Questions and Discussion
121+
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.

src/guides/v2.3/release-notes/2-3-7-p1.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ group: release-notes
33
title: Adobe Commerce 2.3.7-p1 Release Notes
44
---
55

6-
{{ site.data.var.ee }} 2.3.7-p1 is a security-only release that provides 17 security fixes that enhance your Magento 2.3.7 deployment. Merchants can now install time-sensitive security fixes without applying the hundreds of functional fixes and enhancements that a full quarterly release provides. Patch 2.3.7-p1 is a security-only patch that provides fixes for vulnerabilities that have been identified in our previous quarterly release, {{ site.data.var.ee }} 2.3.7 and {{ site.data.var.ce }} 2.3.7.
6+
{{ site.data.var.ee }} 2.3.7-p1 is a security release that provides security fixes that enhance your {{ site.data.var.ee }} 2.3.7 or {{ site.data.var.ce }} 2.3.7 deployment. It provides fixes for vulnerabilities that have been identified in the previous patch release, {{ site.data.var.ee }} 2.3.7 and {{ site.data.var.ce }} 2.3.7.
77

88
{:.bs-callout-info}
99

@@ -29,16 +29,16 @@ Seventeen security fixes and one security enhancement are included in this secur
2929

3030
Rate limiting is now built in to Magento APIs to prevent denial-of-service (DoS) attacks. Web APIs now impose restrictions on the size or number of resources (the default limit is set to 20 and can be configured to a different value based on business need) that can be requested by a client. See [Rate limiting]({{page.baseurl}}/get-started/api-security.html#rate-limiting) for information about configuring these restrictions. <!--- MC-35358-->
3131

32-
Security-only patches typically include all hotfixes that have been released for the preceding complete release. However, no hot fixes have been released for {{ site.data.var.ee }} 2.3.7 and {{ site.data.var.ce }} 2.3.7.
32+
Security patches typically include all hotfixes that have been released for the preceding complete release. However, no hot fixes have been released for {{ site.data.var.ee }} 2.3.7 and {{ site.data.var.ce }} 2.3.7.
3333

3434
## Known issue
3535

3636
**Issue**: _Previously placed order price is displayed when a shopper tries to place an order with a different product using the PayPal payment method_. Magento displays an incorrect order price when a shopper tries to use PayPal to pay for an order after first purchasing a different product. Shoppers can successfully place the first order, but during checkout for the second order, Magento displays the first order’s total price instead of the second order’s correct total. See [{{site.data.var.ee}} 2.3.7-p1 known issue: outdated order total for PayPal](https://support.magento.com/hc/en-us/articles/4405999788685-Adobe-Commerce-2-3-7-p1-known-issue-outdated-order-total-for-PayPal). <!--- MC-42674 -->
3737

3838
## Installation and upgrade instructions
3939

40-
For instructions on downloading and applying security-only patches (including patch 2.4.2-p1), see [Quick start install]({{site.baseurl}}/guides/v2.4/install-gde/composer.html).
40+
For instructions on downloading and applying security patches (including patch 2.4.2-p1), see [Quick start install]({{site.baseurl}}/guides/v2.4/install-gde/composer.html).
4141

4242
## More information?
4343

44-
For general information about security-only patches, see the Magento DevBlog post [Introducing the New Security-only Patch Release](https://community.magento.com/t5/Magento-DevBlog/Introducing-the-New-Security-only-Patch-Release/ba-p/141287).
44+
For general information about security patches, see [Introducing the New Security Patch Release](https://community.magento.com/t5/Magento-DevBlog/Introducing-the-New-Security-Patch-Release/ba-p/141287).

0 commit comments

Comments
 (0)