Skip to content

Reporting Bugs

Jeremy Friesen edited this page Feb 20, 2024 · 1 revision

Reporting Bugs

Thank you for taking the time to report a bug. Your feedback is invaluable to improving the A.I. Snow Day Predictor. This guide outlines the process for reporting bugs effectively, ensuring they are addressed promptly and accurately.

Before Reporting a Bug

  1. Check Existing Issues: Browse the Issues section to see if the bug has already been reported. If you find that your issue has already been reported, feel free to add any additional information to the existing report instead of creating a new one.
  2. Update to the Latest Version: Ensure you're using the latest version of the A.I. Snow Day Predictor. The issue you're experiencing might have already been fixed.

How to Report a Bug Effectively

Step 1: Gather Information

  • Describe the Bug: Provide a clear and concise description of what the bug is.
  • Steps to Reproduce: List the steps to reproduce the behavior. Include commands, links, or actions you took before encountering the bug.
  • Expected Behavior: Describe what you expected to happen.
  • Actual Behavior: Describe what actually happened. Include any error messages or screenshots if possible.
  • Environment: Specify your operating system, version of Docker, and any other relevant environmental details.

Step 2: Create an Issue

Navigate to the Issues page of the repository and click on 'New Issue'. Fill in the title and provide the information you've gathered according to the template provided.

Step 3: Submit the Issue

After filling in all necessary details, submit the issue. The project maintainers will review your report and follow up with any additional questions or updates on the bug's status.

After Reporting

  • Follow Up: Keep an eye on your issue for any requests for additional information or updates on the resolution.
  • Contribute: If you're able to, consider contributing a fix for the bug. Contributions are always welcome, and detailed bug reports make it easier for you or others to identify and resolve issues.

Thank You

We appreciate the time and effort you take to report issues. By providing detailed reports, you're helping to improve the A.I. Snow Day Predictor for everyone.