Bug Reporting Guidelines

🐞 Bug Reporting Guidelines

Clear and thorough reports help us diagnose and fix issues faster, making the platform better for everyone. Please follow the steps below when submitting a bug report on GitHub.

---

❗️Before You Report

Before creating a new issue:

• Check existing issues
  Use the GitHub search to see if the bug has already been reported. If you find a similar issue, add any new details as a comment instead of opening a new one.

• Use the latest version
  Make sure you're testing on the latest version of Audemy to avoid reporting bugs that are already fixed.

• Try to reproduce the bug
  Confirm that the bug can be consistently reproduced. If it's random or hard to reproduce, try to provide as much context as possible.

---

📝 How to Report a Bug

When creating a new issue on GitHub, use the following format to make your report clear and actionable.

---

1. Title

Write a short, descriptive title.
Example:

[Bug] Submit button unresponsive after second question in Addition Game

---

2. Description

Describe the problem in one or two paragraphs. What is happening, and what should happen instead?

Example:

After answering the second question in the Addition Game, the "Submit" button becomes unresponsive. The game does not proceed to the next question, and no feedback is provided.

---

3. Steps to Reproduce

Clearly list the steps someone needs to follow to encounter the bug. Use numbered steps.

Example:

1. Go to the Game Zone
2. Open the Addition Game
3. Answer the first two questions
4. Try clicking the "Submit" button on the third question
5. Notice that nothing happens

---

4. Expected Behavior

Explain what should have happened.

Example:

The "Submit" button should validate the answer, give feedback, and move to the next question.

---

5. Actual Behavior

Explain what actually happened.

Example:

The "Submit" button appears clickable but does not respond or trigger any action. No feedback is shown.

---

6. Screenshots or Recordings

If possible, include a screenshot or screen recording showing the issue. This is especially helpful for UI bugs.

---

7. Environment Details

Provide as much of the following information as you can:

• Device: (if applicable, e.g., Desktop, iPad, Android phone)
• Operating System: (if applicable, e.g., Windows 11, macOS Sonoma, iOS 17)
• Frontend Version: (if available, e.g., commit hash or version tag)
• Backend Version: (if relevant, e.g., API version or commit hash)

---

8. Additional Context

Add any other relevant information. This might include:

• Whether you're logged in or not
• Any accessibility tools you're using (like screen readers)
• Whether you’re using keyboard-only navigation
• If this happens every time or only sometimes

---

📌 Example Bug Report

Here’s a complete example:

Title: [Bug] "Submit" button stops working after 2nd question in Addition Game

Description: After answering two questions, clicking "Submit" no longer advances the game or shows feedback. This happens consistently.

Steps to Reproduce:

1. Log in as a Student
2. Start the Addition Game
3. Answer the first two questions
4. Try clicking "Submit" on the third question

Expected Behavior:
"Submit" should process the answer and load the next question

Actual Behavior:
Nothing happens, and the game gets stuck

Environment Info:

• Device: Desktop
• OS: Mac
• Frontend version: v0.3.4

Additional Context:
Happens every time; tried both keyboard and mouse inputs.

---