Skip to content

Magento Issue Gates

Lena Orobei edited this page Dec 5, 2019 · 10 revisions

Magento issues that are reported on the public GitHub 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 Magento Core developers or Community Developers. The purpose of these gates is to identify core technical issues common to all reported tickets, and to show the progress on each individual reported issue.

Gate 1 - Automatic Verification

Goal: Automatically verify that reported issue follows Issue Reporting Guidelines. The reported issue must contain all the following keywords in the description section:

  • Preconditions
  • Steps to Reproduce
  • Actual Result
  • Expected Result

Results:

  • Label Issue: Format is valid will be added if the issue passed automatic verification
  • Label Issue: Format is not valid will be added if the issue failed automatic format verification
  • Maintainer can fix the issue description and add missing information. Label Progress: needs update will be added. Reporter has 14 days to update the issue description; otherwise, we will close the issue.
  • Maintainer can update the issue description format if sufficient information is provided.

Gate 2 - Manual Verification

Goal: Manual verification of the description. The reported issue must meet all the following requirements:

  • must contain Preconditions (Magento version). PHP Version, MySQL version, Web Server, is Sample Data installed are optional at this stage and can be requested later. A reporter can add this information to speed up the bug fix process.
  • must have Steps to Reproduce. This should be a clear description of how we can reproduce the issue using a clean Magento installation (without third-party extensions and customizations) and without migration from Magento 1. Migration issue should be reported in the repository magento/data-migration-tool
  • must have Actual Result. This should be a clear description of the actual result. Screenshots and video recordings are optional at this stage, but highly recommended.
  • must have Expected Result. This should be a clear description how Magento should behave in the provided scenario.

Results:

  • The Magento Team will review the issue to confirm that it has a meaningful description.
  • Once all requirements met, we’ll add the  Issue: Clear Description label.
  • If the issue does not have a meaningful description, the maintainer will request additional information from the reporter. Label Progress: needs update will be added. The reporter has 14 days to update the issue description, otherwise, the issue will be closed.

Gate 3 - Reproducing the Issue

Goal: Reproduce the issue following Steps to Reproduce from the issue description.

What do we test? We test each issue against the latest 2.4-develop branch.

Results: We can add the following labels:

  • Issue: Confirmed - the issue is reproducible by provided Steps to Reproduce
  • Reproduced on 2.4.x - the issue was reproduced on latest releases from 2.4 release line
  • Fixed in 2.3.x - the issue already fixed in latest 2.3.x release
  • Fixed in 2.4.x - the issue already fixed in latest 2.4.x release
  • Issue: Cannot Reproduce - the issue is not reproducible on reported version

Bug Fix

If the issue was reproduced on Gate 3, we’ll create an internal MAGETWO ticket to track the progress of the issue.

Once an issue has been acknowledged, either Magento Core Developers or Magento Community Developers can fix it. We encourage everyone to join the Magento Community Contribution Team and submit Pull Request with the bug fix to magento/magento2 repository.