Skip to content

skill: tighten PR-description and CI-authoring guidance for agents#1224

Open
rgsl888prabhu wants to merge 3 commits into
NVIDIA:mainfrom
rgsl888prabhu:skill/ci-pr-minimalism-guidance
Open

skill: tighten PR-description and CI-authoring guidance for agents#1224
rgsl888prabhu wants to merge 3 commits into
NVIDIA:mainfrom
rgsl888prabhu:skill/ci-pr-minimalism-guidance

Conversation

@rgsl888prabhu
Copy link
Copy Markdown
Collaborator

Updates skills/cuopt-developer to capture the reviewer feedback from #1194:

  • Expand the PR-description rule with an explicit "don't include" list (how-it-works walkthroughs, file tables, exhaustive test-plan checklists).
  • Add a new "Editing CI scripts and workflows" section: prefer extending existing scripts, don't restate framework defaults, no fallback values for required inputs, hard-code GitHub URLs, validate early, split chained bash commands.

Goal is to keep future agent-authored PRs that touch ci/ or .github/workflows/ from generating the same review round-trips.

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>
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented May 14, 2026

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 rgsl888prabhu self-assigned this May 14, 2026
@rgsl888prabhu rgsl888prabhu added non-breaking Introduces a non-breaking change improvement Improves an existing functionality labels May 14, 2026
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>
@rgsl888prabhu rgsl888prabhu marked this pull request as ready for review May 14, 2026 19:54
@rgsl888prabhu rgsl888prabhu requested a review from a team as a code owner May 14, 2026 19:54
@rgsl888prabhu rgsl888prabhu requested a review from Iroy30 May 14, 2026 19:54
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 14, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 449d0a0c-dfc2-4d0b-8db8-ac57fcfd44f9

📥 Commits

Reviewing files that changed from the base of the PR and between 82f7828 and aa79f26.

📒 Files selected for processing (1)
  • skills/cuopt-developer/SKILL.md

📝 Walkthrough

Walkthrough

Documentation-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.

Changes

Expanded contribution guidelines

Layer / File(s) Summary
Contributing guidelines expansion
skills/cuopt-developer/SKILL.md, skills/cuopt-developer/resources/contributing.md
SKILL.md fixes "walk-through"→"walkthrough" and updates the contributing reference. contributing.md adds detailed PR description rules and a "Writing scripts and CI workflows" subsection with do/don't checklist and constraints for scripts/CI authoring.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title directly summarizes the main change: tightening PR-description and CI-authoring guidance for agents, which aligns with the documented updates to the cuopt-developer skill.
Description check ✅ Passed The description clearly relates to the changeset by explaining the motivation (reviewer feedback from #1194), listing specific guidance updates (PR-description don't-includes and new CI scripts section), and stating the goal to reduce review round-trips.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 19c2060 and 82f7828.

📒 Files selected for processing (2)
  • skills/cuopt-developer/SKILL.md
  • skills/cuopt-developer/resources/contributing.md

Comment thread skills/cuopt-developer/SKILL.md
@rgsl888prabhu rgsl888prabhu requested a review from mlubin May 14, 2026 21:20
Match the unhyphenated form already used elsewhere in the file.

Signed-off-by: Ramakrishna Prabhu <ramakrishnap@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

improvement Improves an existing functionality non-breaking Introduces a non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant