Skip to content

Conversation

@Adez017
Copy link
Contributor

@Adez017 Adez017 commented Oct 19, 2025

Which issue does this PR close?

Rationale for this change

What changes are included in this PR?

Are these changes tested?

Yes

Are there any user-facing changes?

Not in application

Summary by CodeRabbit

  • Chores
    • Added user-facing issue templates for bug reports and feature requests (includes guided fields to describe the problem, reproduction steps, expected behavior, proposed solution, alternatives, and additional context).
    • Enabled support for blank issue submissions and applied default labels: "bug" for bug reports and "enhancement" for feature requests.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 19, 2025

Walkthrough

Adds three GitHub issue-template files under .github/ISSUE_TEMPLATE/: a bug report template, a feature request template, and a config file enabling blank/custom issues. The bug template requires a bug description; other fields across templates guide reporters.

Changes

Cohort / File(s) Summary
GitHub Issue Templates
​.github/ISSUE_TEMPLATE/bug_report.yml, ​.github/ISSUE_TEMPLATE/feature_request.yml, ​.github/ISSUE_TEMPLATE/config.yml
Adds a bug report template (required "Describe the bug" textarea; optional "To Reproduce", "Expected behavior", "Additional context"); adds a feature request template (problem context, requested solution, alternatives, additional context; labels include enhancement); adds config.yml with blank_issues_enabled: true.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

gssoc25, level1, hacktoberfest-accepted

Poem

🐛 A bug box, a wish, a config flip,
Issues tidy with a helpful script,
Report, request, or something new —
Templates keep the flow cool and true. ✨

Pre-merge checks

✅ Passed checks (5 passed)
Check name Status Explanation
Title Check ✅ Passed The title "added templates for issues" is directly related to the primary change in the pull request. The changeset introduces three new files for GitHub issue templates (bug report, feature request, and configuration), and the title accurately reflects this main objective. The phrasing is concise, clear, and specific enough that a reviewer can understand the core purpose without being overly verbose or generic.
Linked Issues Check ✅ Passed The pull request successfully addresses the requirements from linked issue #7. The PR delivers the bug report template and feature request template as specified. Additionally, the config.yml file with blank_issues_enabled set to true fulfills the "custom template" requirement by allowing users to create custom blank issues alongside the predefined templates. All three template objectives from the issue are met through the three new files added in this changeset.
Out of Scope Changes Check ✅ Passed All changes in this pull request are directly aligned with the objectives from linked issue #7. The three modified/new files are: bug_report.yml, feature_request.yml, and config.yml—all of which are essential to implement the issue template system. The config.yml addition is appropriately scoped as it enables custom blank issues, which complements the predefined templates. No unrelated or extraneous changes were introduced.
Description Check ✅ Passed The pull request description follows the required template structure with all major sections present. The author has completed the essential fields: linked issue (#7), test status (Yes), and user-facing impact (Not in application). While the "Rationale for this change" and "What changes are included in this PR?" sections are empty, these can be considered non-critical since the linked issue provides context and the changes are straightforward template additions. The description includes enough information for reviewers to understand the scope and nature of the changes.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 138001f and 67441db.

📒 Files selected for processing (1)
  • .github/ISSUE_TEMPLATE/config.yml (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/ISSUE_TEMPLATE/config.yml

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.

@Adez017
Copy link
Contributor Author

Adez017 commented Oct 19, 2025

@xkaper001 , i had added the templates for the issues . if possible could you add level 2 here.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eb33bb4 and 138001f.

📒 Files selected for processing (3)
  • .github/ISSUE_TEMPLATE/bug_report.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/config.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/feature_request.yml (1 hunks)
🔇 Additional comments (2)
.github/ISSUE_TEMPLATE/bug_report.yml (1)

1-27: Well-designed bug report template.

The template strikes a good balance—requiring only the bug description while encouraging supplementary details through optional fields. The placeholders are clear and guide users toward providing actionable information.

.github/ISSUE_TEMPLATE/feature_request.yml (1)

1-26: Thoughtful feature request template.

The template design is solid—the problem context field explicitly guides users to explain the why alongside the what, which helps maintainers understand motivation. The alternatives field encourages well-reasoned proposals.

Minor note: Consider adding a trailing newline to this file for consistency with standard file formatting conventions, though this is optional.

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@xkaper001
Copy link
Owner

This looks good to me. @Adez017 This is a low-effort task, and level1 is justified for this.

@xkaper001 xkaper001 added gssoc25 GirlScript Summer of Code'25 level1 gssoc - Level 1 hacktoberfest-accepted labels Oct 19, 2025
@Adez017
Copy link
Contributor Author

Adez017 commented Oct 20, 2025

could you now merge it @xkaper001

@xkaper001 xkaper001 merged commit c9d66de into xkaper001:dev Oct 22, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gssoc25 GirlScript Summer of Code'25 hacktoberfest-accepted level1 gssoc - Level 1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add templates for issues

2 participants