Skip to content

Issue reporting guidelines

Possible Issue labels

Label Description
Bug A problem which impairs or prevents the functions of the setup.
Enhancement An improvement or enhancement to an existing feature.
Confirmed The issue is a bug and has been confirmed by team.
In Progress This issue is being actively worked on at the moment by the team.
New Feature A new feature which has yet to be developed.
Contact support Contact our support team at [email protected]. Issue will be closed with no further action.
Read Documentation Issue will be closed. Read available documentation.
Done Work done on the issue.
Resolved A issue is resolved and tested.
Can't Reproduce The issue has been reviewed by a team, but it can't be replicated with the provided information and context.
Duplicate Issue has been already reported and will be closed with no further action.
Conflict Issue reports a conflict with other third party extension.
Won't Fix for Now The issue is legitimate, but it is not something the team is currently able or willing to fix or implement. Issues may be revisited in the future.
Info Needed The issue needs more information before it can be verified and resolved.
Wrong issue format Wrong format in reported issue.
priority-blocker Blocks development and testing work, production could not run.
priority-critical Crashes, loss of data, severe memory leak.
priority-major Major loss of function.
priority-minor Minor loss of function, or other problem where easy workaround is present.
priority-trivial Cosmetic problem like misspelled words or misaligned text

To maintain an effective issue workflow and make sure issues will be solved in a timely manner we kindly ask reporters to follow some guidelines.

    • Check the documentation to make sure the behavior you are reporting is really a bug, not a feature.
    • Check the existing issues to make sure you are not duplicating somebody‚Äôs work.

If you are sure that the problem you are experiencing is caused by a bug, file a new issue in a Github issue tracker following the recommendations below.

Title

Title is a important part of bug report for developer and a trigger to quickly identify an unique issue. A title should contain a clear, brief explanation of the issue, making emphasis on the most important points.

Issue Description

Preconditions

Describing preconditions is a great start, provide information on system configuration settings you have changed, detailed information on Magento versions. Basically, everything that would help developer set up the same environment as you have.

Example:

1. Magento CE 2.0.1 without sample data is installed.
2. mc-magento 1.0.6.
3. Test category is set up.

Steps to reproduce

This part of the bug report is the most important, as developer will use this information to reproduce the issue. Problem is more likely to be fixed if it can be reproduced.

Precisely describe each step you have taken to reproduce the issue. Try to include as much information as possible, sometimes even minor differences can be crucial.

Example:

1. Logged into admin panel as super admin.
2. Open Store Configuration.
3. Click "General tab".

Actual and Expected result

Precisely describe the result you expected to get and the result you actually observed after performing the steps.

Example:

Expected result:
Add to cart button should be visible on product page.
Actual result:
Add to cart button is not visible on product page.

Additional information

Additional information is often requested when the bug report is processed, you can save time by providing Magento and browser logs, screenshots, any other artifacts related to the issue.