govind-kumarr / simple_rag_dashboard

Chat with your docs. The deployed link is not updated. Please setup project locally to find issues.
19 stars 32 forks source link

Add Issue Template #73

Closed aasthakourav20 closed 1 month ago

aasthakourav20 commented 1 month ago

What's missing in this repository!! Adding an issue template file to a repository is a practice that benefits both the maintainers and the contributors of a project. Here are several key reasons why this is important:

  1. Standardization and Consistency An issue template helps ensure that every issue submitted follows a consistent structure. This makes it easier for maintainers to review and address issues since they can quickly find the relevant information.

  2. Improved Clarity and Detail Templates guide contributors to provide all necessary details. They can include sections for the issue description, steps to reproduce, expected behavior, actual behavior, environment details, and any relevant screenshots or logs. This reduces the back-and-forth communication needed to gather essential information.

  3. Efficient Triage With all the required information in place, maintainers can triage issues more efficiently. They can quickly determine the severity, priority, and required resources to address the issue.

  4. Better User Experience For contributors, especially new ones, templates offer a clear and guided way to report issues. This lowers the barrier to entry for contributing to the project and ensures that their reports are more likely to be acted upon.

  5. Reduced Duplicate Issues By including a checklist or reminders in the template to search for existing issues before submitting a new one, the occurrence of duplicate issues can be minimized. This helps maintain a cleaner issue tracker.

Kindly assign this task to me under GSSoC'24

github-actions[bot] commented 1 month ago

Congratulations, @aasthakourav20! 🎉 Thank you for creating your issue. Your contribution is greatly appreciated and we look forward to working with you to resolve the issue. Keep up the great work!

We will promptly review your changes and offer feedback. Keep up the excellent work! Kindly remember to check our contributing guidelines