chore: PR and issue templates

[tjirab]

Adds a PR template for future PRs.

Summary by CodeRabbit

• Chores
  • Introduced standardized bug report template with structured form fields for consistent issue submissions.
  • Added feature request template to guide new feature proposals with required fields.
  • Implemented pull request template to standardize PR descriptions and change documentation.
  • Configured issue template settings and added quick-access links for documentation and support resources.

[coderabbitai]

Walkthrough

Added standardized GitHub issue and pull request templates to structure bug reports, feature requests, and PR submissions. The configuration disables blank issues and provides quick links to community resources.

Changes

Cohort / File(s)	Summary
Issue Template Configuration .github/ISSUE_TEMPLATE/config.yml	Disables blank issue creation; adds contact links for Discord, documentation, bug reports, and feature requests
Bug Report Template .github/ISSUE_TEMPLATE/bug_report.yml	Structured form with required fields for component, description, reproduction steps, expected/actual behavior, environment, and optional code samples and error logs
Feature Request Template .github/ISSUE_TEMPLATE/feature_request.yml	Structured form with fields for component selection, feature description, problem statement, proposed solution, use cases, optional code example, and impact checkboxes
Pull Request Template .github/pull_request_template.md	Markdown template with sections for description, change type checklist, related issues, changes summary, examples, and optional screenshots/videos

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

These are static configuration and template files requiring validation of field structure, accuracy of component/category options, alignment with project conventions, and clarity of placeholder text. No executable logic or dependencies to trace.

Poem

Forms beget forms—the void demands its order,
Each checkbox a small bell tolling purpose,
While blank pages finally find their walls,
And chaos kneels before the template's steel.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "chore: PR and issue templates" directly and accurately summarizes the primary changes in the changeset. The title clearly identifies that the PR adds both a PR template (pull_request_template.md) and multiple issue templates (bug_report.yml, feature_request.yml, and config.yml). The conventional commit prefix "chore:" appropriately categorizes this as a maintenance change, and the title is concise, specific, and avoids vague language. A developer scanning commit history would immediately understand that this PR introduces standardized templates for project workflow.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between fc032bf and b058a2e.

📒 Files selected for processing (4)

• .github/ISSUE_TEMPLATE/bug_report.yml (1 hunks)
• .github/ISSUE_TEMPLATE/config.yml (1 hunks)
• .github/ISSUE_TEMPLATE/feature_request.yml (1 hunks)
• .github/pull_request_template.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

.github/pull_request_template.md

[grammar] ~9-~9: There might be a mistake here.
Context: ... - [ ] 🐛 Bug fix (non-breaking change which fixes an issue) - [ ] ✨ New feature (no...

(QB_NEW_EN)

---

[style] ~9-~9: Consider using a different verb for a more formal wording.
Context: ...] 🐛 Bug fix (non-breaking change which fixes an issue) - [ ] ✨ New feature (non-brea...

(FIX_RESOLVE)

---

[grammar] ~9-~9: There might be a mistake here.
Context: ...on-breaking change which fixes an issue) - [ ] ✨ New feature (non-breaking change w...

(QB_NEW_EN)

---

[grammar] ~10-~10: There might be a mistake here.
Context: ... [ ] ✨ New feature (non-breaking change which adds functionality) - [ ] 💥 Breaking c...

(QB_NEW_EN)

---

[grammar] ~10-~10: There might be a mistake here.
Context: ...reaking change which adds functionality) - [ ] 💥 Breaking change (fix or feature t...

(QB_NEW_EN)

---

[grammar] ~11-~11: There might be a mistake here.
Context: ...g functionality to not work as expected) - [ ] 📚 Documentation update - [ ] 🔧 Ref...

(QB_NEW_EN)

---

[grammar] ~12-~12: There might be a mistake here.
Context: ... expected) - [ ] 📚 Documentation update - [ ] 🔧 Refactoring (no functional change...

(QB_NEW_EN)

---

[grammar] ~13-~13: There might be a mistake here.
Context: ...] 🔧 Refactoring (no functional changes) - [ ] ⚡ Performance improvement - [ ] 🧪 T...

(QB_NEW_EN)

---

[grammar] ~14-~14: There might be a mistake here.
Context: ...changes) - [ ] ⚡ Performance improvement - [ ] 🧪 Test improvements - [ ] 🔌 Plugin...

(QB_NEW_EN)

---

[grammar] ~15-~15: There might be a mistake here.
Context: ...e improvement - [ ] 🧪 Test improvements - [ ] 🔌 Plugin/Integration changes - [ ] ...

(QB_NEW_EN)

---

[grammar] ~16-~16: There might be a mistake here.
Context: ...ents - [ ] 🔌 Plugin/Integration changes - [ ] 📦 Dependencies update ## Related I...

(QB_NEW_EN)

---

[grammar] ~17-~17: There might be a mistake here.
Context: ...ion changes - [ ] 📦 Dependencies update ## Related Issues <!-- Link to any related...

(QB_NEW_EN)

---

[grammar] ~23-~23: There might be a mistake here.
Context: ...ixes #123" or "Closes #123" --> Fixes # Closes # Related to # ## Changes Made ...

(QB_NEW_EN)

---

[grammar] ~24-~24: There might be a mistake here.
Context: ..." or "Closes #123" --> Fixes # Closes # Related to # ## Changes Made <!-- Prov...

(QB_NEW_EN)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: unit / Test "not integration"
• GitHub Check: unit / Ruff & mypy

🔇 Additional comments (4)

.github/pull_request_template.md (1)

1-41: Well-designed PR template with clear guidance.

The template provides excellent structure for standardizing PR descriptions without being prescriptive. The Type of Change checkboxes cover a good range of scenarios, and the guidance comments help authors understand what to include.

Minor note: The static analysis tool flagged some grammar suggestions about "which" vs "that" throughout the template. These are stylistic preferences in informal documentation; no action needed unless you prefer stricter formal language for PRs.

.github/ISSUE_TEMPLATE/bug_report.yml (1)

1-143: Excellent bug report template with comprehensive form design.

The template thoughtfully guides users through bug reporting with a logical flow: identify the component, provide description and steps, contrast expected vs. actual behavior, and include diagnostic information. The plugin dropdown is particularly thorough. The required fields strike a good balance—essential information is required while flexibility is preserved for optional context like code samples and logs.

.github/ISSUE_TEMPLATE/feature_request.yml (1)

1-117: Well-structured feature request template with strong problem-solution framework.

The template effectively guides feature requesters through essential thinking: What problem are we solving? What's the proposed solution? What are the use cases? The Impact Assessment checkboxes at the end are particularly valuable—they prompt requesters to consider breaking changes, documentation needs, and performance implications upfront, which aids triage and planning.

.github/ISSUE_TEMPLATE/config.yml (1)

1-14: All external URLs are accessible and functioning correctly.

Verification results confirm:

• Discord invite link (HTTP 301): Active and operational
• Documentation domain (HTTP 200): Resolving successfully
• GitHub issue template links (HTTP 302): Redirecting as expected

The .github/ISSUE_TEMPLATE/config.yml file is properly configured with valid, working URLs that will not create user friction.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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