| title | labels |
|---|---|
... |
troubleshooting,... |
Title should briefly describe the issue, maximum 70 characters is preferred.
(Example: "Out of memory error during install or upgrade".)
See Contributing > Metadata for additional information on metadata.
Intro paragraph or two paragraphs: a brief overview of issue. The first 140 characters are important for SEO purposes.
- Magento Commerce x.x.x
- Magento Commerce Cloud x.x.x
- Affected extension or technology (e.g. Redis, Fastly): x.x.x
A clear description of the issue, including full error messages as text and any important screenshots. If this is found in a log, provide details: which log, location.
Remove any specific project IDs or customer information from errors and logs! Also make sure sensitive information is not included in screen shots.
If the issue occurs in a very specific situation, provide detailed steps to reproduce, expected result and actual result in the following format:
Steps to reproduce:
Prerequisites: ... (if any).
- First step.
- Second step.
- ....
Expected result:
Magento does this.
Actual result:
Magento does that.
The reason why the issue occurs. Don't describe the fix — it should be in the next section. Skip this option if the reason is not clear or not important in this case.
How to fix the issue. Use a numbered list for steps. Finish the section with the results: error not displayed, deploy works, value changed and how to see the change, etc.
If there is a temporary workaround, specify it as a separate section below this one.
- User Guides: Commerce
- Developer Guide
- Other Knowledge Base articles
- Any related resources (blogs, forums, StackOverflow, etc.)