Skip to main content

Effective Issue Report

Please note

This content was created by AI and might contain inaccuracies.

When reporting an issue or a bug, please follow this template to ensure that all necessary information is included. This will help developers understand and resolve the issue more efficiently.

  1. Title: Provide a concise and descriptive title that summarizes the issue.
  2. Environment: Specify the environment where the bug was encountered, including:
    • Operating System (e.g., Windows, macOS, Linux)
    • Browser (if applicable, e.g., Chrome, Firefox)
    • Application version (e.g., v1.2.3)
  3. Steps to Reproduce: List the exact steps needed to reproduce the bug. Be as detailed as possible, including:
    • Initial conditions (e.g., user logged in, specific settings)
    • Actions taken (e.g., clicked a button, entered text)
    • Expected outcome (what you expected to happen)
    • Actual outcome (what actually happened)
  4. Screenshots/Logs: Attach any relevant screenshots or logs that can help illustrate the issue. This can include:
    • Error messages
    • Screenshots of the UI
    • Console logs or application logs
  5. Frequency: Indicate how often the bug occurs (e.g., always, sometimes, rarely).
  6. Impact: Describe the impact of the bug on the user experience or functionality. This can include:
    • Severity (e.g., critical, major, minor)
    • Affected features or workflows
  7. Additional Information: Provide any other relevant information that might help in diagnosing the issue, such as:
    • Recent changes made to the system
    • Related issues or bugs
    • Workarounds (if any)
  8. Contact Information: Include your contact information for follow-up questions or clarifications, if necessary.
  9. Priority: If applicable, indicate the priority level of the bug (e.g., high, medium, low) to help prioritize fixes.
  10. Assigned To: If known, specify who the bug is assigned to for resolution.
  11. Status: Indicate the current status of the bug (e.g., open, in progress, resolved) to keep track of its lifecycle.
  12. Version Control: If applicable, mention the version control branch or commit where the bug was found, to help trace the issue in the codebase.