-
Notifications
You must be signed in to change notification settings - Fork 1
chore: GitHub templates (bug/feature/task/PR/RFC) #92
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Summary by CodeRabbit
WalkthroughAdds GitHub templates and documentation updates: an RFC discussion template, three issue templates (bug/feature/task), issue template configuration, a pull request template, and decision/execution-plan doc edits. No runtime code changes. (≤50 words) Changes
Sequence Diagram(s)(omitted — changes are template/config and documentation only; no control-flow modifications to visualize) Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 6
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (6)
.github/DISCUSSION_TEMPLATE/rfc.yml(1 hunks).github/ISSUE_TEMPLATE/bug.yml(1 hunks).github/ISSUE_TEMPLATE/config.yml(1 hunks).github/ISSUE_TEMPLATE/feature.yml(1 hunks).github/ISSUE_TEMPLATE/task.yml(1 hunks).github/PULL_REQUEST_TEMPLATE.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
.github/PULL_REQUEST_TEMPLATE.md
1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
🪛 YAMLlint (1.37.1)
.github/ISSUE_TEMPLATE/bug.yml
[error] 41-41: too many blank lines (1 > 0)
(empty-lines)
.github/DISCUSSION_TEMPLATE/rfc.yml
[error] 33-33: too many blank lines (1 > 0)
(empty-lines)
.github/ISSUE_TEMPLATE/config.yml
[error] 6-6: too many blank lines (1 > 0)
(empty-lines)
.github/ISSUE_TEMPLATE/feature.yml
[error] 23-23: too many blank lines (1 > 0)
(empty-lines)
.github/ISSUE_TEMPLATE/task.yml
[warning] 14-14: too few spaces before comment: expected 2
(comments)
[warning] 14-14: missing starting space in comment
(comments)
[error] 24-24: too many blank lines (1 > 0)
(empty-lines)
⏰ 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). (1)
- GitHub Check: Security Audit
🔇 Additional comments (1)
.github/PULL_REQUEST_TEMPLATE.md (1)
1-18: PR template structure is solid, but address markdown linting rule MD041 if enforced.The markdownlint rule MD041 expects a top-level H1 heading as the first line. PR templates often omit this in favor of starting with form content directly. If your project enforces this rule, add a heading like
# Pull Requestat line 1. Otherwise, ignore the warning—the current structure is functional and clear.If you want to keep the current structure without heading, you may need to disable MD041 in
.markdownlint.jsonor the template configuration to prevent CI failures.
…lank line in config.yml
…ts/echo into echo/pr-templates-and-project
… fix YAML lint; update execution-plan + decision-log for Docs Guard
There was a problem hiding this 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: ASSERTIVE
Plan: Pro
📒 Files selected for processing (7)
.github/DISCUSSION_TEMPLATE/rfc.yml(1 hunks).github/ISSUE_TEMPLATE/bug.yml(1 hunks).github/ISSUE_TEMPLATE/config.yml(1 hunks).github/ISSUE_TEMPLATE/feature.yml(1 hunks).github/ISSUE_TEMPLATE/task.yml(1 hunks)docs/decision-log.md(2 hunks)docs/execution-plan.md(1 hunks)
⏰ 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). (1)
- GitHub Check: Security Audit
🔇 Additional comments (6)
docs/decision-log.md (1)
24-25: Decision log entries accurately capture template PR scope and lint fixes.Lines 24–25 and line 136 appropriately record the PR's aims: templates (bug/feature/task/RFC), project board config, YAML hygiene, and MD022 markdown lint fix. The dual entry (narrative in line 24–25, table summary in line 136) may feel redundant, but it aligns with the document's hybrid format. No issues.
Also applies to: 136-136
docs/execution-plan.md (1)
42-57: Execution plan entries provide clear context for template/cleanup work.The added "Today's Intent" entries (lines 42–57) document the PR's scope well: template additions, project board config, cleanup for scope hygiene, and markdown lint fix reference. Cross-references to branches and decisions are clear. Formatting follows established patterns. No issues.
.github/ISSUE_TEMPLATE/config.yml (1)
1-5: Issue template config is clean and well-formed.
blank_issues_enabled: falseenforces template usage, and the RFC contact link correctly routes to GitHub Discussions (Ideas category). YAML is valid, trailing blank line properly removed. The config ties together the new templates and provides a gateway for RFC proposals. Solid setup..github/ISSUE_TEMPLATE/feature.yml (1)
1-22: Feature template is well-structured and guidance is appropriate.The template guides users through problem statement, scope/boundaries, and cross-linking—exactly what a feature proposal needs. The "feat: " title prefix is idiomatic. The inline guidance ("child tasks will capture steps") ties nicely to the Task template workflow. No YAML issues. Trailing blank line correctly removed.
.github/ISSUE_TEMPLATE/task.yml (1)
1-23: Task template is well-designed; YAML placeholder fix is correct.The 1–3 hour scope and 5-per-feature cap align with decomposition strategy. Parent issue linkage prevents orphaned tasks. The placeholder
"e.g., #22"is now properly quoted—past YAMLlint flagged this correctly, and it's been fixed. Steps + acceptance criteria are standard. Title format consistent. No trailing blank line. Template is solid..github/DISCUSSION_TEMPLATE/rfc.yml (1)
1-32: RFC discussion template covers the essential decision points.Seven sections (summary, motivation, design, alternatives, risks, rollout) follow standard RFC practice. Rollout Plan is a smart inclusion—most proposals gloss over implementation, but it's critical. The sections encourage deliberate thinking without overwhelming the proposer. No YAML issues. Trailing blank line removed. Clean.
…bug template; update plan + decision log for Docs Guard
There was a problem hiding this 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: ASSERTIVE
Plan: Pro
📒 Files selected for processing (3)
.github/ISSUE_TEMPLATE/bug.yml(1 hunks)docs/decision-log.md(2 hunks)docs/execution-plan.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/execution-plan.md
[uncategorized] ~60-~60: The official name of this software platform is spelled with a capital “H”.
Context: ... Bug template triage fields - Enhanced .github/ISSUE_TEMPLATE/bug.yml with optional f...
(GITHUB)
docs/decision-log.md
[uncategorized] ~26-~26: The official name of this software platform is spelled with a capital “H”.
Context: ...l stack_trace and version fields to .github/ISSUE_TEMPLATE/bug.yml | Capture logs ...
(GITHUB)
⏰ 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). (1)
- GitHub Check: Security Audit
🔇 Additional comments (2)
docs/execution-plan.md (1)
42-60: Good documentation discipline. These entries track the work clearly.Your execution-plan updates are well-timestamped and connect the template/project-board changes to concrete deliverables. Keeping this living document in sync with your PRs makes the decision trail auditable.
docs/decision-log.md (1)
24-26: Decision log entries are properly structured and complete.Your new entries (templates scope, docs lint, bug template triage, and project config) are all populated correctly with context, decision, rationale, and consequences. This is how you keep institutional memory alive across commits.
Also applies to: 137-137
Adds GitHub templates for:
Also configured the Echo project board Status options (Blocked/Ready/Done) via API so we can use a simple Kanban.