Skip to content

Bug Reporting Template

Jump to bottom
Samuel Wong edited this page Nov 3, 2024 · 2 revisions

Here is the bug reporting template to follow, also label it as a bug:

Title: [Bug] Short Description of the Bug

Description: Provide a concise summary of the bug. Explain what you expected to happen, and what actually happened.

Steps to Reproduce:

  1. Step-by-step instructions to reproduce the bug.
  2. Include any specific configurations, settings, or conditions.
  3. If possible, add screenshots or GIFs that capture the issue.

Expected Behavior: Describe what you expected to happen when following the steps above.

Actual Behavior: Describe what actually happened when following the steps above.

Screenshots / Visuals: Add any relevant screenshots or video clips that demonstrate the issue.

Environment Details:

  • OS: (e.g., Windows 10, macOS Big Sur, Ubuntu 20.04)
  • Browser (if applicable): (e.g., Chrome 90, Firefox 88)
  • Application Version / Commit: (e.g., v1.0.3 or commit hash abc123)
  • Any additional context relevant to the environment (e.g., network connection, specific configurations).

Additional Context / Notes: Provide any additional information that may help in resolving the issue, such as related issues, past occurrences, or troubleshooting steps attempted.

Clone this wiki locally