When reporting an issue for our team to investigate, it's crucial to provide clear and detailed information. This helps our developers understand and address the problem effectively. Please follow the template below to ensure all necessary details are included.
Environment
First, gather and provide information about your environment. This helps us understand the context in which the issue occurs. Run the following command and paste the output:
npx envinfo --system --npmPackages '@front-commerce/*' --binaries --browsers
Additionally, list any other relevant details about your environment, such as operating system, device type, browser version, etc.
Steps to Reproduce
Detail the steps required to reproduce the issue. Number each step and use the “>” symbol to indicate transitions between screens or actions. Keep the list concise but comprehensive.
Example:
Go to settings > Profile (this will take the user to a new screen)
Tap on More Options > Delete Account
Providing step-by-step instructions helps developers replicate the issue quickly and accurately.
Expected Result
Describe what should happen when the steps are followed correctly. Think about the desired outcome from an end-user perspective and provide deeper insights beyond stating that "the app should not crash."
Example:
The profile page should display user information.
After tapping "Delete Account," a confirmation dialog should appear.
Actual Result
Explain what actually happens when the steps are followed. Be specific about the issue, whether the application crashes, nothing happens, or an error message is displayed. Providing distinct information helps make the bug report more actionable.
Example:
The app crashes and closes immediately after tapping "Delete Account."
No confirmation dialog appears, and the account is not deleted.
Proof
Attach any relevant screenshots, videos, or log files. Visual proof is crucial for understanding the issue. If the issue requires steps to trigger, a video is necessary. For minor UI issues always present, a screenshot will suffice. Logs are also required, regardless of the issue.
Screenshots: Show the UI issue or error message.
Videos: Capture the steps leading to the issue.
Logs: Include system logs and crash log dumps if the application crashes.
Technical Notes
(Optional) Provide any technical insights you might have about the issue.
Possible Root Cause: Describe any suspicions about what might be causing the issue.
Possible Solution or Location of the Bug: Suggest any potential fixes or areas where the bug might reside.
By following this template, you ensure our team has all the necessary information to start investigating and resolving the issue promptly. Thank you for your cooperation!