Skip to content

fix(doc): update issue template#10

Merged
Sunny6889 merged 1 commit intodevelopfrom
fix_github_template
Mar 20, 2026
Merged

fix(doc): update issue template#10
Sunny6889 merged 1 commit intodevelopfrom
fix_github_template

Conversation

@Sunny6889
Copy link
Owner

@Sunny6889 Sunny6889 commented Mar 20, 2026

What does this PR do?

  • Remove duplication parts.

Why are these changes required?

This PR has been tested by:

  • Unit Tests
  • Manual Testing

Follow up

Extra details

Summary by CodeRabbit

  • Documentation
    • Clarified that Additional Context is optional in the bug report template
    • Streamlined the feature request template by consolidating background information sections
    • Made Alternatives Considered and Additional Context optional in the feature request template
    • Reorganized the feature request form for improved clarity and user experience

@coderabbitai
Copy link

coderabbitai bot commented Mar 20, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2c40e0f1-893c-46cd-b8f4-1bf481554a71

📥 Commits

Reviewing files that changed from the base of the PR and between 6fa13dd and d39a117.

📒 Files selected for processing (2)
  • .github/ISSUE_TEMPLATE/report-a-bug.md
  • .github/ISSUE_TEMPLATE/request-a-feature.md

📝 Walkthrough

Walkthrough

GitHub issue templates updated to improve contributor experience. The bug report template marks "Additional Context" as optional, while the feature request template consolidates and reorders sections, combining Background and Rationale into Problem Statement, making Alternatives Considered and Additional Context optional, and moving Testing Strategy to appear after Estimated Complexity.

Changes

Cohort / File(s) Summary
Issue Template Updates
.github/ISSUE_TEMPLATE/report-a-bug.md, .github/ISSUE_TEMPLATE/request-a-feature.md
Bug template header clarified as optional. Feature template restructured: consolidated Background and Rationale into Problem Statement, reordered Testing Strategy, marked Alternatives Considered and Additional Context as optional, added numbered placeholders for test scenarios.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 Templates reformed with care and grace,
Optional fields find their place,
Questions combined, the flow refined,
Contributors now know what's on our mind!

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix_github_template
📝 Coding Plan
  • Generate coding plan for human review comments

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

@Sunny6889 Sunny6889 merged commit 38d516f into develop Mar 20, 2026
5 of 12 checks passed
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.

2 participants