skill: tighten PR-description and CI-authoring guidance for agents#1224
Merged
rapids-bot[bot] merged 4 commits intoMay 15, 2026
Merged
Conversation
Add explicit anti-patterns for PR descriptions (no how-it-works walkthroughs, file tables, exhaustive test-plan checklists) and a new "Editing CI scripts and workflows" section covering the reviewer feedback themes from NVIDIA#1194: don't restate framework defaults, no fallback values for required inputs, hard-code GitHub URLs, validate early, split chained bash commands. Signed-off-by: Ramakrishna Prabhu <ramakrishnap@nvidia.com>
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
rgsl888prabhu
added
non-breaking
Shorten the PR-description section, and broaden the CI rules to cover all scripts (shell, Python helpers, workflows) rather than just CI files. Signed-off-by: Ramakrishna Prabhu <ramakrishnap@nvidia.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughDocumentation-only changes: contributing.md gains detailed PR-description rules and a "Writing scripts and CI workflows" checklist; SKILL.md updates one wording instance and its reference to the expanded contributing guidance. ChangesExpanded contribution guidelines
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 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)
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 `@skills/cuopt-developer/SKILL.md`:
- Line 205: The file uses mixed spelling for "walkthrough" (hyphenated
"walk-through" at one occurrence vs unhyphenated at another); update the
hyphenated instance to the unhyphenated form "walkthrough" so both occurrences
match — locate the hyphenated token "walk-through" in SKILL.md (the earlier
paragraph around line 13) and replace it with "walkthrough".
🪄 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: CHILL
Plan: Enterprise
Run ID: 17376b28-cf13-4222-8afd-75753dd05f04
📒 Files selected for processing (2)
skills/cuopt-developer/SKILL.mdskills/cuopt-developer/resources/contributing.md
Match the unhyphenated form already used elsewhere in the file. Signed-off-by: Ramakrishna Prabhu <ramakrishnap@nvidia.com>
tmckayus
approved these changes
May 15, 2026
mlubin
reviewed
May 15, 2026
|
|
||
| Shell scripts, Python helper tools, and CI workflows all attract speculative complexity — flags, fallbacks, and config knobs that "might be useful" but trace back to no real problem. Strip it. | ||
|
|
||
| - Prefer extending an existing script over adding a new one. If you add a new file, be ready to say why an existing one didn't fit. |
Contributor
There was a problem hiding this comment.
We can shorten most of these instructions by saying to follow YAGNI design (for scripts and CI workflows, not necessarily for the whole codebase).
Per review: collapse the speculative-complexity bullets into a single YAGNI rule (scoped to scripts and CI, not the whole repo), keep only the non-YAGNI points (extend existing files, validate early, readable shell, non-blocking CI jobs). Signed-off-by: Ramakrishna Prabhu <ramakrishnap@nvidia.com>
Collaborator
Author
|
@mlubin May I get another round of review on this PR |
mlubin
approved these changes
May 15, 2026
Collaborator
Author
|
/merge |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updates
skills/cuopt-developerto capture the reviewer feedback from #1194:Goal is to keep future agent-authored PRs that touch
ci/or.github/workflows/from generating the same review round-trips.