What to Include When Reporting an Issue

1. Clear and Concise Title

Begin with a brief summary that encapsulates the problem.
Example: “App crashes when uploading a photo on Android 12.”Pathwright Help

2. Detailed Description

Explain what you were doing when the issue occurred, what you expected to happen, and what actually happened.
Example: “While uploading a profile picture, the app crashes after selecting the image from the gallery.”Pathwright Help+1Mykeels+1

3. Steps to Reproduce

List the exact steps to replicate the issue. This helps the support team or developers to experience the problem firsthand.
Example:

Open the app.
Navigate to the profile section.
Tap on 'Edit Profile'.
Select 'Change Photo' and choose an image from the gallery.
App crashes immediately.

4. Expected vs. Actual Behavior

Clarify what you anticipated versus what occurred.
Expected: “The selected image should upload and display as the profile picture.”
Actual: “The app crashes upon selecting an image.”Pathwright Help

5. Environment Details

Provide information about your device and software environment.

Device Model: e.g., Samsung Galaxy S21
Operating System: e.g., Android 12
App Version: e.g., 5.2.1
Browser (if applicable): e.g., Chrome 95.0

6. Error Messages and Logs

Include any error messages, codes, or logs that appeared. Screenshots or screen recordings can be particularly helpful.

7. Frequency and Timing

Note how often the issue occurs and when it was first noticed.
Example: “The crash happens every time I attempt to upload a photo since the last app update on April 20, 2025.”

8. Troubleshooting Steps Taken

Mention any steps you've already tried to resolve the issue.
Example: “Cleared app cache and reinstalled the app, but the issue persists.”

9. Additional Context

Provide any other relevant information, such as network conditions, account details, or specific settings.
Example: “Issue occurs only when connected to Wi-Fi, not on mobile data.”

Knowledge Base Article