skill: tighten PR-description and CI-authoring guidance for agents#1224
skill: tighten PR-description and CI-authoring guidance for agents#1224rgsl888prabhu wants to merge 3 commits into
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. |
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 |
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>
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.