Skip to content

cuopt-skill-evolution: add low-maintenance/fail-loud design rule#1561

Merged
rapids-bot[bot] merged 2 commits into
mainfrom
skill-low-maintenance-design
Jul 13, 2026
Merged

cuopt-skill-evolution: add low-maintenance/fail-loud design rule#1561
rapids-bot[bot] merged 2 commits into
mainfrom
skill-low-maintenance-design

Conversation

@ramakrishnap-nv

Copy link
Copy Markdown
Collaborator

Adds a contribution design heuristic (rule 6) to the cuopt-developer skill: when adding any API or wrapping layer, keep a single source of truth (derive, don't duplicate) and prefer designs that fail loudly over ones that silently misbehave.

Generalized from a maintenance issue raised while refactoring the routing DataModel — a hand-maintained list mirroring the wrapper's methods and shadow state kept only for a check.

🤖 Generated with Claude Code

…uopt-developer

Refactoring the routing DataModel (PR #1556) surfaced recurring maintenance
footguns: a hand-maintained list mirroring the Cython wrapper's method surface,
and shadow state kept only for a set-time check. Generalize the lesson into a
contribution design heuristic that applies to adding any API/layer -- derive
from a single source of truth rather than duplicating a surface, and prefer
designs that fail loudly (guarded by a coverage test) over ones that silently
misbehave.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Ramakrishna Prabhu <ramakrishnap@nvidia.com>
@ramakrishnap-nv ramakrishnap-nv added this to the 26.08 milestone Jul 10, 2026
@copy-pr-bot

copy-pr-bot Bot commented Jul 10, 2026

Copy link
Copy Markdown

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.

@ramakrishnap-nv ramakrishnap-nv marked this pull request as ready for review July 10, 2026 22:02
@ramakrishnap-nv ramakrishnap-nv requested a review from a team as a code owner July 10, 2026 22:02
@ramakrishnap-nv ramakrishnap-nv requested a review from Iroy30 July 10, 2026 22:02
@ramakrishnap-nv ramakrishnap-nv self-assigned this Jul 10, 2026
@ramakrishnap-nv ramakrishnap-nv added non-breaking Introduces a non-breaking change improvement Improves an existing functionality Agentic This label is used to track agentic and skill related issues labels Jul 10, 2026
@ramakrishnap-nv

Copy link
Copy Markdown
Collaborator Author

/nvskills-ci

@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown

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: 7758f09b-15a0-4c61-92e8-77200bf37159

📥 Commits

Reviewing files that changed from the base of the PR and between 93c2678 and 2ace0f4.

📒 Files selected for processing (3)
  • skills/cuopt-developer/BENCHMARK.md
  • skills/cuopt-developer/skill-card.md
  • skills/cuopt-developer/skill.oms.sig

📝 Walkthrough

Walkthrough

The cuOpt developer skill now includes low-maintenance design guidance. Its metadata, references, credential requirements, evaluation records, benchmark values, and signed DSSE bundle were updated.

Changes

Developer skill updates

Layer / File(s) Summary
Low-maintenance design rules
skills/cuopt-developer/SKILL.md
Adds single-source-of-truth and fail-loud design guidance.
Skill metadata and evaluation records
skills/cuopt-developer/skill-card.md, skills/cuopt-developer/BENCHMARK.md
Updates credential requirements, references, output and evaluation metadata, version source, benchmark date, and reported results.
Signature bundle regeneration
skills/cuopt-developer/skill.oms.sig
Regenerates the DSSE payload digests and signature for the updated skill artifacts.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

  • NVIDIA/cuopt#1287: Updates overlapping cuopt-developer artifacts and the corresponding signature bundle.
  • NVIDIA/cuopt#1301: Changes related cuopt-developer documentation, benchmark data, and signature payload digests.
  • NVIDIA/cuopt#1475: Updates the same skill artifacts, evaluation results, and DSSE bundle.

Suggested reviewers: Iroy30, tmckayus

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately describes the main change: adding a low-maintenance, fail-loud design rule.
Description check ✅ Passed The description directly explains the added design heuristic and its motivation, matching the changeset.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch skill-low-maintenance-design

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

Signed-off-by: nvskills-svc-account <svc-nvskills-signing@nvidia.com>
@copy-pr-bot

copy-pr-bot Bot commented Jul 10, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions

Copy link
Copy Markdown

CI Test Summary

✅ All 0 test job(s) passed.

@ramakrishnap-nv

Copy link
Copy Markdown
Collaborator Author

/ok to test 2ace0f4

@ramakrishnap-nv

Copy link
Copy Markdown
Collaborator Author

/merge

@rapids-bot rapids-bot Bot merged commit 37a099e into main Jul 13, 2026
44 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Agentic This label is used to track agentic and skill related issues 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.

3 participants