docs: add Issue Management guidelines to CONTRIBUTING.md#170
Conversation
Add standardized issue management section covering: - Title prefix convention ([Bug], [Feature], [Epic], [Perf], [Design]) - Priority definitions (P0/P1/P2) - Label taxonomy and usage rules - Issue lifecycle (create → triage → develop → PR link → close) - Epic & Sub-issue conventions - Issue Types as supplementary classification Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
📝 WalkthroughWalkthroughAdded "Issue Management" section to CONTRIBUTING.md establishing GitHub issue title prefix conventions ( Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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.
Code Review
This pull request introduces a comprehensive 'Issue Management' section to the CONTRIBUTING.md file, detailing title conventions, priority levels, labeling, and the issue lifecycle. The review feedback identifies missing title prefixes for documentation and questions to ensure consistency with the stated rules, and suggests refining the response time description for P2 priority issues to better align with the temporal definitions used for other priorities.
| | Prefix | Usage | Label | | ||
| |--------|-------|-------| | ||
| | `[Bug]` | Bug report | `bug` | | ||
| | `[Feature]` | Feature request | `enhancement` | | ||
| | `[Epic]` | Large milestone or roadmap | `epic` | | ||
| | `[Perf]` | Performance issue or optimization | `performance` | | ||
| | `[Design]` | Kernel design proposal | `design-proposal` | |
There was a problem hiding this comment.
The 'Title Convention' table is missing prefixes for the documentation and question labels, which are listed as 'Type labels' in the Labels section (line 130). Since the guide states that all issue titles must start with a type prefix, these should be explicitly defined to ensure consistency and guide contributors correctly.
| | Prefix | Usage | Label | | |
| |--------|-------|-------| | |
| | `[Bug]` | Bug report | `bug` | | |
| | `[Feature]` | Feature request | `enhancement` | | |
| | `[Epic]` | Large milestone or roadmap | `epic` | | |
| | `[Perf]` | Performance issue or optimization | `performance` | | |
| | `[Design]` | Kernel design proposal | `design-proposal` | | |
| | Prefix | Usage | Label | | |
| |--------|-------|-------| | |
| | [Bug] | Bug report | bug | | |
| | [Feature] | Feature request | enhancement | | |
| | [Epic] | Large milestone or roadmap | epic | | |
| | [Perf] | Performance issue or optimization | performance | | |
| | [Design] | Kernel design proposal | design-proposal | | |
| | [Docs] | Documentation improvement | documentation | | |
| | [Question] | General question or clarification | question | |
| | Priority | Meaning | Response Time | | ||
| |----------|---------|---------------| | ||
| | `P0` | Blocking — affects core functionality or CI | Immediate | | ||
| | `P1` | Important — must complete in current iteration | Start within a week | | ||
| | `P2` | Improvement — can be scheduled for later | Planned | |
There was a problem hiding this comment.
In the Priority table, 'Planned' is listed as a 'Response Time' for P2 issues. This term describes a status rather than a temporal expectation. Consider using a more specific time-based description to align with the 'Immediate' and 'Start within a week' values used for P0 and P1.
| | Priority | Meaning | Response Time | | |
| |----------|---------|---------------| | |
| | `P0` | Blocking — affects core functionality or CI | Immediate | | |
| | `P1` | Important — must complete in current iteration | Start within a week | | |
| | `P2` | Improvement — can be scheduled for later | Planned | | |
| | Priority | Meaning | Response Time | | |
| |----------|---------|---------------| | |
| | P0 | Blocking — affects core functionality or CI | Immediate | | |
| | P1 | Important — must complete in current iteration | Start within a week | | |
| | P2 | Improvement — can be scheduled for later | Best effort / Next iteration | |
Summary
## Issue Managementsection to CONTRIBUTING.md covering title prefix convention, priority definitions, label taxonomy, issue lifecycle, Epic/Sub-issue conventions, and Issue Types usagedesign-proposal,cpu-refTest plan
🤖 Generated with Claude Code
Summary by CodeRabbit