Add Standardized GitHub Issue Templates (Closes #121)#124
Conversation
Added issue template configuration with contact links.
Added a bug report template for issue tracking.
Added a feature request template for GitHub issues.
This template allows users to suggest improvements to documentation, including README and guides.
|
@Nitya-003 is attempting to deploy a commit to the Dot_NotSam's projects Team on Vercel. A member of the Team first needs to authorize it. |
Thanks for creating a PR for your Issue!
|
📝 WalkthroughWalkthroughThis PR establishes standardized GitHub issue templates to improve issue reporting quality. Four files are added: a bug report template, feature request template, documentation update template, and template configuration with blank issue settings and contact links. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
.github/ISSUE_TEMPLATE/bug_report.md (1)
40-45: Consider decoupling the checklist from internal source paths.The backtick-quoted paths (
lib/compatibility.ts,lib/suggestions.ts,lib/data.ts) are a helpful hint right now, but they will silently become misleading if any of those files are renamed or moved during a refactor. Use logical layer names only (matching thefeature_request.mdstyle) or keep paths as optional parenthetical hints that are easier to update.♻️ Proposed change
## Affected Area - [ ] UI (Component Selector / Build Summary) -- [ ] Compatibility Engine (`lib/compatibility.ts`) -- [ ] Suggestion Engine (`lib/suggestions.ts`) -- [ ] Data Layer (`lib/data.ts`) +- [ ] Compatibility Engine +- [ ] Suggestion Engine +- [ ] Data Layer - [ ] Other:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/ISSUE_TEMPLATE/bug_report.md around lines 40 - 45, The checklist in the bug report template exposes brittle internal source paths (`lib/compatibility.ts`, `lib/suggestions.ts`, `lib/data.ts`) that can become misleading; update the checklist under "Affected Area" to use stable logical layer names (e.g., "Compatibility Engine", "Suggestion Engine", "Data Layer") only or move file paths into optional parenthetical hints (not the primary label) so renames won’t break the guidance — modify the checkbox lines shown in the diff accordingly to remove or demote the backtick-quoted paths..github/ISSUE_TEMPLATE/documentation_update.md (1)
29-30: Remove emoji from section heading for consistency across templates.The
🎯prefix on this heading is the only emoji used across all three templates' section headings. Keeping headings in plain text aligns withbug_report.mdandfeature_request.md.♻️ Proposed change
-## 🎯 Why This Matters +## Why This Matters🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/ISSUE_TEMPLATE/documentation_update.md around lines 29 - 30, Remove the emoji from the "## 🎯 Why This Matters" heading so it matches the other templates; replace that heading text with "## Why This Matters" (update the heading string in the template where "## 🎯 Why This Matters" appears).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/ISSUE_TEMPLATE/bug_report.md:
- Around line 32-36: Add an "App Version" entry to the "## Environment" section
so reporters can include the app version or commit SHA; update the Environment
list to include a line like "App Version (e.g., v1.2.3 or commit SHA):" directly
under the existing items to ensure reproducible reports when fixes are deployed.
---
Nitpick comments:
In @.github/ISSUE_TEMPLATE/bug_report.md:
- Around line 40-45: The checklist in the bug report template exposes brittle
internal source paths (`lib/compatibility.ts`, `lib/suggestions.ts`,
`lib/data.ts`) that can become misleading; update the checklist under "Affected
Area" to use stable logical layer names (e.g., "Compatibility Engine",
"Suggestion Engine", "Data Layer") only or move file paths into optional
parenthetical hints (not the primary label) so renames won’t break the guidance
— modify the checkbox lines shown in the diff accordingly to remove or demote
the backtick-quoted paths.
In @.github/ISSUE_TEMPLATE/documentation_update.md:
- Around line 29-30: Remove the emoji from the "## 🎯 Why This Matters" heading
so it matches the other templates; replace that heading text with "## Why This
Matters" (update the heading string in the template where "## 🎯 Why This
Matters" appears).
| ## Environment | ||
| - OS: | ||
| - Browser: | ||
| - Device: | ||
| - Screen Size (if UI related): |
There was a problem hiding this comment.
Consider adding an App Version field to the Environment section.
Without a version or commit SHA, it can be difficult to reproduce or close a bug after a fix is deployed.
🛡️ Proposed addition
## Environment
- OS:
- Browser:
- Device:
- Screen Size (if UI related):
+- RigCrafter Version / Commit:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.github/ISSUE_TEMPLATE/bug_report.md around lines 32 - 36, Add an "App
Version" entry to the "## Environment" section so reporters can include the app
version or commit SHA; update the Environment list to include a line like "App
Version (e.g., v1.2.3 or commit SHA):" directly under the existing items to
ensure reproducible reports when fixes are deployed.
2 participants
Description
This PR introduces structured GitHub Issue Templates to improve issue quality, streamline triaging, and enhance contributor onboarding for RigCrafter.
Previously, contributors were presented with a blank issue box, often resulting in incomplete reports and additional back-and-forth from maintainers. These templates ensure all necessary technical and contextual details are provided upfront.
Closes #121
Changes Made
Added
.github/ISSUE_TEMPLATE/directory containing:config.ymlbug_report.mdfeature_request.mddocumentation_update.mdWhy This Matters
Type of Change
Summary by CodeRabbit
Release Notes