Bug Reporting Guidelines

Don’t make fun bug reports. Bug reports should be taken seriously, as they help improve the software. Follow these guidelines to write clear and actionable bug reports:

1. Be Specific and Clear

   • Describe the issue in detail. Avoid vague statements like "it doesn’t work."
   • Include the steps to reproduce the issue so others can verify it.

2. Provide Context

   • Mention the environment where the bug occurred (e.g., operating system, browser, app version).
   • If possible, include related information like error messages or logs.

3. Use a Clear Title

   • Write a short, descriptive title summarizing the issue (e.g., "eGlow sends wrong data for certain players").

4. Attach Screenshots or Videos

   • Visual evidence can help developers understand the problem faster. Annotate screenshots if needed.
   • Make sure this includes a screenshot of the /eglow debug output.

5. List Expected vs. Actual Behavior

   • State what you expected to happen and what actually happened. This contrast helps identify the issue clearly.

6. Avoid Duplicate Reports

   • Check if the issue has already been reported before submitting. This saves time for everyone involved.

7. Stay Professional

   • Be respectful and concise in your language. Avoid blaming or frustration-filled comments.

8. Include Severity and Frequency

   • Mention how severe the issue is (e.g., critical, minor) and how often it occurs (e.g., always, sometimes).

9. Suggest Possible Causes (Optional)

   • If you have technical knowledge, briefly suggest what might be causing the bug.

10. Follow the Format Provided

    • If a bug report template is available, use it to ensure all necessary details are included.