Improve Issue Reporting with a Structured Template

[VeVarunSharma]

Description:

The current state of issue reporting in this repository is inconsistent, making it difficult to efficiently triage and resolve bugs. To enhance the quality and clarity of issues, I propose implementing a structured template that guides contributors to provide essential information.

Proposed Template:

Bug Report

Title: [Clear and Concise Title]

Description:

• Detailed explanation of the bug or issue.
• Steps to reproduce the problem.
• Expected behavior.
• Actual behavior.

Environment:

• Operating system (e.g., Windows, macOS, Linux).
• Browser (if applicable).
• Version of the software.
• Any relevant dependencies.

Screenshots/Logs:

• Attach any relevant screenshots, error messages, or log files.

Additional Information:

• Any other relevant details that might be helpful.

Benefits of Using a Template:

• Improved clarity: Consistent structure makes issues easier to understand.
• Faster resolution: Essential information is readily available, reducing investigation time.
• Better collaboration: Contributors can more easily provide relevant details.

Action Items:

• Create a template: Add a new .github/ISSUE_TEMPLATE.md file to the repository.
• Update issue guidelines: Document the use of the template in the repository's contributing guidelines.
• Encourage adoption: Promote the use of the template in issue discussions and pull requests. 🚀

Also, if anyone has other ideas on how to improve the template we can converse here on in the corresponding PR! I'd imagine that it would evolve over but at least there will be a base to iterate off of! We can keep it simple for now :)