chore: fix stale label guidance, add issue-type policy#1315
Conversation
njhensley
added
the
theme/community
📝 WalkthroughWalkthroughThis PR updates contribution policy guidance in Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 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)
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
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.claude/CLAUDE.md:
- Around line 646-652: Update the doc text around the two commands: remove the
invalid REST API example "gh api repos/NVIDIA/aicr/issues -f title='…' -f
body='…' -f type='Bug'" and replace the incorrect version claim for the CLI flag
so the line with "--type Bug" reads that the flag was introduced in gh v2.94.0+,
not 2.63; also add a short note that org issue types cannot be set via the
standard Issues REST create/edit endpoints and must be set via the gh CLI
(v2.94.0+), the web UI, or project/automation that has project-scoped
permissions.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: ebd40028-f7a2-4e2d-bad0-a5bdfd013fe1
📒 Files selected for processing (2)
.claude/CLAUDE.mdAGENTS.md
mchmarny
left a comment
mchmarny
left a comment
There was a problem hiding this comment.
Guidance is accurate and well-reasoned — the theme/* correction and issue-type policy are both good additions. One medium concern: the gh api REST fallback for setting issue types likely doesn't work (REST issues endpoint doesn't accept a type field; it's GraphQL-only). Everything else is clean. Nothing blocks merge if the REST example is corrected or removed.
There was a problem hiding this comment.
♻️ Duplicate comments (2)
.claude/CLAUDE.md (1)
648-649:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winIncorrect REST API guidance contradicts past review findings.
Line 649 states "Current REST Issues create/edit endpoints also accept
typefor users with push access," but the prior review's web search definitively found that the standard GitHub REST Issues create/edit endpoints do NOT support setting organization issue types via atypeparameter—it's a query-only parameter for filtering, not a write-enabled field.Remove the claim about REST endpoints accepting
typeand simplify to: "With olderghversions, use the web UI or ask maintainers to set the type."📝 Proposed correction
- Prefer `gh issue create --type Bug ...` (requires `gh` v2.94.0+); use `gh issue edit <n> --type Bug` for existing issues. - - With older `gh` versions, use the web UI or automation with the needed permissions. Current REST Issues create/edit endpoints also accept `type` for users with push access, but avoid stale ad hoc `gh api` examples because older clients or API versions may reject or silently drop the field. + - With older `gh` versions, use the web UI to set the type after creating the issue.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.claude/CLAUDE.md around lines 648 - 649, Remove the incorrect claim "Current REST Issues create/edit endpoints also accept `type` for users with push access" and replace it with a simplified statement like "With older `gh` versions, use the web UI or ask maintainers to set the type." Locate the offending sentence (the phrase starting with "Current REST Issues create/edit endpoints...") and update the surrounding guidance to avoid suggesting REST API support for a writable `type` field, keeping the note about using web UI or maintainers for older gh clients.AGENTS.md (1)
648-649:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winSame incorrect REST API guidance as in
.claude/CLAUDE.md.Line 649 incorrectly states that REST Issues create/edit endpoints accept
type. This mirrors the issue flagged in.claude/CLAUDE.mdat line 649—the standard REST API does not support setting org issue types via atypebody parameter.Apply the same correction here as in
.claude/CLAUDE.md.📝 Proposed correction
- Prefer `gh issue create --type Bug ...` (requires `gh` v2.94.0+); use `gh issue edit <n> --type Bug` for existing issues. - - With older `gh` versions, use the web UI or automation with the needed permissions. Current REST Issues create/edit endpoints also accept `type` for users with push access, but avoid stale ad hoc `gh api` examples because older clients or API versions may reject or silently drop the field. + - With older `gh` versions, use the web UI to set the type after creating the issue.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@AGENTS.md` around lines 648 - 649, The sentence claiming "Current REST Issues create/edit endpoints also accept `type`" is incorrect; update AGENTS.md to remove/replace that claim with the corrected guidance used elsewhere: state that the REST Issues create/edit endpoints do not support a `type` body parameter, recommend using `gh issue create --type Bug` / `gh issue edit <n> --type Bug` with gh v2.94.0+ or the web UI/automation with proper permissions for older clients, and remove any stale `gh api` examples that rely on sending `type`.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Duplicate comments:
In @.claude/CLAUDE.md:
- Around line 648-649: Remove the incorrect claim "Current REST Issues
create/edit endpoints also accept `type` for users with push access" and replace
it with a simplified statement like "With older `gh` versions, use the web UI or
ask maintainers to set the type." Locate the offending sentence (the phrase
starting with "Current REST Issues create/edit endpoints...") and update the
surrounding guidance to avoid suggesting REST API support for a writable `type`
field, keeping the note about using web UI or maintainers for older gh clients.
In `@AGENTS.md`:
- Around line 648-649: The sentence claiming "Current REST Issues create/edit
endpoints also accept `type`" is incorrect; update AGENTS.md to remove/replace
that claim with the corrected guidance used elsewhere: state that the REST
Issues create/edit endpoints do not support a `type` body parameter, recommend
using `gh issue create --type Bug` / `gh issue edit <n> --type Bug` with gh
v2.94.0+ or the web UI/automation with proper permissions for older clients, and
remove any stale `gh api` examples that rely on sending `type`.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: c44ed5e4-d381-4fdc-938f-43074af77daa
📒 Files selected for processing (2)
.claude/CLAUDE.mdAGENTS.md
3 participants
Summary
Fix stale label guidance in
CLAUDE.md/AGENTS.md: drop the non-existentenhancement/bug/documentation"type labels", point PR authors at the realtheme/*+dependencieslabels, and add an Issue policy covering org issue types.Motivation / Context
CLAUDE.mdrecommended PR "type labels"enhancement,bug, anddocumentationthat do not exist in the repo — they were used on 0 of the last 40 merged PRs. The real PR labels in use arearea/*,size/*,theme/*, anddependencies. Those three phantom names are actually NVIDIA org-level issue types, which apply to issues, not PRs. This corrects the guidance and documents how to set org issue types on new issues.Fixes: N/A
Related: N/A
Type of Change
Component(s) Affected
docs/,examples/).claude/CLAUDE.md,AGENTS.md)Implementation Notes
theme/*labels +dependencies, and a note thatenhancement/bug/documentationare org issue types, not repo labels.labeldocumentation`` →area/docsfor doc-only PRs.Task/Bug/Enhancement/Epic/Initiative/Documentation) on new issues, with bothgh issue create --typeand thegh api … -f type=REST fallback (localgh2.46 has no--typeflag), plus a note that the Project boardType/Priorityfields are a separate, project-scoped mechanism.AGENTS.mdre-synced from the canonical.claude/CLAUDE.md; verified withtools/check-agents-sync.Testing
./tools/check-agents-sync # OK: AGENTS.md is in sync with .claude/CLAUDE.mdDocs-only change (no Go files touched).
Risk Assessment
Rollout notes: N/A — agent-instruction text only.
Checklist
make testwith-race)make lint)git commit -S)