Reporting Issues

Reporting Bugs or Issues

To report bugs or issues, follow these steps:

  1. Create a new issue on our GitHub repository: Link to GitHub repository
  2. Use the provided template to ensure all necessary information is included in your report.
  3. Provide a clear and concise description of the issue, including:
    • What you expected to happen
    • What actually happened
    • Steps to reproduce the issue
    • Any relevant error messages or screenshots
    • The version of the software you are using
  4. If applicable, include a link to a sample project that demonstrates the issue.

Required Information

When reporting an issue, it is essential to provide the following information:

  • Software version: Specify the exact version number of the software you are using.
  • Operating system: Indicate the operating system you are running (e.g., Windows, macOS, Linux).
  • Environment: Describe the environment in which you are experiencing the issue (e.g., development environment, production server).
  • Steps to reproduce: Provide detailed instructions on how to reproduce the issue, including any specific actions or data needed.
  • Expected behavior: Clearly state what you expected to happen.
  • Actual behavior: Describe what actually happened, including any error messages or unexpected results.
  • Screenshots or logs: Include screenshots of the issue or relevant log files, if available.

Issue Prioritization and Addressing

Reported issues are prioritized based on their severity and impact. We use the following priority levels:

  • Critical: Issues that prevent the software from working as intended, requiring immediate attention.
  • High: Issues that significantly impact usability or performance, needing prompt resolution.
  • Medium: Issues that cause minor inconvenience or affect specific features, requiring attention within a reasonable timeframe.
  • Low: Issues that are cosmetic or have minimal impact, addressed when possible.

Once an issue is reported, our development team will review it, assign it a priority level, and work on a solution.

Tracking Issue Status

You can track the status of reported issues on our GitHub repository. Issues are labeled with statuses such as:

  • Open: The issue is currently under investigation.
  • In Progress: The issue is being actively worked on.
  • Resolved: The issue has been addressed, and a solution has been implemented.
  • Closed: The issue has been resolved and is no longer considered active.

Expected Turnaround Time for Fixes

The turnaround time for fixing reported issues varies depending on the severity and complexity of the issue. Generally, critical and high-priority issues are addressed within a shorter timeframe, while medium and low-priority issues may take longer to resolve.

We strive to provide timely updates and keep you informed about the progress of your reported issues.