Skip to content

feat: add GitHub issue templates (bug, feature, docs) Closes #70#128

Open
Kaustubh1204 wants to merge 1 commit intoAOSSIE-Org:mainfrom
Kaustubh1204:issue-70-templates
Open

feat: add GitHub issue templates (bug, feature, docs) Closes #70#128
Kaustubh1204 wants to merge 1 commit intoAOSSIE-Org:mainfrom
Kaustubh1204:issue-70-templates

Conversation

@Kaustubh1204
Copy link

@Kaustubh1204 Kaustubh1204 commented Jan 21, 2026

This PR adds structured GitHub issue templates to the repository to improve clarity for contributors.

Includes:

  • Bug Report template
  • Feature Request template
  • Documentation Update template
  • Config file for blank/general issues

These templates will standardize issue submissions and make the repository feel more organized and contributor-friendly.

Closes #70

Summary by CodeRabbit

  • Chores
    • Added standardized GitHub issue templates to improve issue submissions and information collection
    • Bug report template requires reproduction steps, expected/actual behavior, and environment details
    • Feature request template captures problem, proposed solution, and additional context
    • Documentation update template allows users to suggest documentation improvements
    • Configured issue template settings with link to discussions for general questions

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 21, 2026

📝 Walkthrough

Walkthrough

This PR introduces structured GitHub issue templates for bug reports, feature requests, and documentation updates. A configuration file enables blank issues and links to discussions for general support questions. The templates enforce required fields to capture reproduction steps, expected behavior, environment details, proposed solutions, and documentation suggestions.

Changes

Cohort / File(s) Change Summary
GitHub Issue Templates
.github/ISSUE_TEMPLATE/bug_report.yml, .github/ISSUE_TEMPLATE/feature_request.yml, .github/ISSUE_TEMPLATE/documentation.yml
Introduces three structured templates with required fields: Bug Report (reproduction steps, expected/actual behavior, environment), Feature Request (problem, proposed solution, context), and Documentation Update (affected page, suggested changes)
Issue Template Configuration
.github/ISSUE_TEMPLATE/config.yml
Enables blank issues and adds a GitHub Discussions link for users to direct general questions and support inquiries

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Templates bloom like carrots so bright,
Structuring issues, making them right!
Bugs, features, docs—all neatly arranged,
Clarity hops forth, beautifully changed! 🌟

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main change: adding GitHub issue templates for bug reports, feature requests, and documentation, which aligns with the changeset content.
Linked Issues check ✅ Passed All coding requirements from issue #70 are met: bug report template, feature request template, documentation template, and blank issue config are all implemented as requested.
Out of Scope Changes check ✅ Passed All changes are directly related to issue #70 objectives; no out-of-scope modifications detected in the four template files added.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Enhancement - Introduce Issue Templates like Bugs, Features & Documentation Updates for Better Clarity

1 participant