[docs, ci] chore: add governance issue forms and triage guide#2716
[docs, ci] chore: add governance issue forms and triage guide#2716
Conversation
Document the repo's governance labels and triage views in CONTRIBUTING, and replace free-form issue templates with structured forms so maintainers and oncall can route work consistently. Made-with: Cursor Signed-off-by: Yu Yao <yaoyu.094@gmail.com>
|
/ok to test e0b3c8c |
📝 WalkthroughWalkthroughGitHub issue templates are migrated from Markdown to YAML format for bug reports, feature requests, and model support requests. A new standardized support request template is introduced. CONTRIBUTING.md is updated with labeling and triage governance documentation. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 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 |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
201-247: Consider clarifying type vs. area for docs and ci.Both
docsandciappear as type labels (lines 210-211) and as area labels (area:docs,area:ciat lines 244-245). While this may be intentional (type = what kind of work, area = what code domain), the overlap could confuse contributors.Consider adding a brief clarification, e.g., "Use
docsas a type when the PR is purely documentation; usearea:docsas an area when a feature or bug also touches documentation."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` around lines 201 - 247, Add a short clarifying sentence in the "Type Labels" / "Area Labels" section explaining the distinction and when to use the overlapping labels: state that `docs` and `ci` are type labels to classify the kind of work (e.g., documentation-only or CI/automation changes) while `area:docs` and `area:ci` are area labels to indicate the code/domain affected when a PR also modifies implementation; place this sentence adjacent to the two tables and use the exact label names `docs`, `ci`, `area:docs`, and `area:ci` so contributors see the mapping clearly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@CONTRIBUTING.md`:
- Around line 201-247: Add a short clarifying sentence in the "Type Labels" /
"Area Labels" section explaining the distinction and when to use the overlapping
labels: state that `docs` and `ci` are type labels to classify the kind of work
(e.g., documentation-only or CI/automation changes) while `area:docs` and
`area:ci` are area labels to indicate the code/domain affected when a PR also
modifies implementation; place this sentence adjacent to the two tables and use
the exact label names `docs`, `ci`, `area:docs`, and `area:ci` so contributors
see the mapping clearly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: d58d562b-3f3e-4f32-b38e-de989a0d415a
📒 Files selected for processing (8)
.github/ISSUE_TEMPLATE/bug_report.md.github/ISSUE_TEMPLATE/bug_report.yml.github/ISSUE_TEMPLATE/feature_request.md.github/ISSUE_TEMPLATE/feature_request.yml.github/ISSUE_TEMPLATE/model-support-request.md.github/ISSUE_TEMPLATE/model_support_request.yml.github/ISSUE_TEMPLATE/support_request.ymlCONTRIBUTING.md
💤 Files with no reviewable changes (3)
- .github/ISSUE_TEMPLATE/bug_report.md
- .github/ISSUE_TEMPLATE/model-support-request.md
- .github/ISSUE_TEMPLATE/feature_request.md
…taxonomy Add area:peft and area:perf labels to all issue form dropdowns. Update model support request architecture family options with concrete examples. Align CONTRIBUTING.md area descriptions with the label taxonomy and fix high-conflict-risk -> high-complexity naming. Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com> Made-with: Cursor
|
/ok to test 31c3e56 |
… instead) docs and ci are type labels, not area labels. Remove area:ci and area:docs from CONTRIBUTING.md and issue template dropdowns to avoid duplication with the type label taxonomy. Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com> Made-with: Cursor
|
/ok to test 8296146 |
| [recipe, docs] feat: Add Llama 3.1 70B recipe with documentation | ||
| [ckpt] fix: Handle missing keys in HF checkpoint conversion | ||
| [BREAKING][training] refactor: Change optimizer config structure | ||
| [ci, build] chore: Update ruff version |
There was a problem hiding this comment.
is it still necessary to write tags in the PR title if we have the appropriate labels as you outlined below?
There was a problem hiding this comment.
just recommendation, to keep it very clear in git history
| | Label | Meaning | | ||
| | --- | --- | | ||
| | `needs-triage` | New item needs classification and ownership | | ||
| | `needs-author` | Author action is required before review or merge can continue | |
There was a problem hiding this comment.
suggest renaming to "waiting-for-author"
Add needs-review, needs-follow-up state labels and needs-more-tests risk label. Clarify when an issue leaves needs-triage and the expected state transitions after maintainer engagement. Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com> Made-with: Cursor
|
/ok to test f820300 |
Signed-off-by: Yu Yao <yaoyu.094@gmail.com> Signed-off-by: yaoyu-33 <yaoyu.094@gmail.com>
Summary
CONTRIBUTING.mdneeds-triageandneeds-follow-upTest plan
pre-commit runMade with Cursor
Summary by CodeRabbit