chore: Misc release prep - #163
Conversation
Signed-off-by: David Gardner <dagardner@nvidia.com>
…d-pre-release-cleanups Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Enterprise Run ID: 📒 Files selected for processing (1)
📜 Recent review details⏰ Context from checks skipped due to timeout. (20)
🧰 Additional context used📓 Path-based instructions (11)**/*.{md,rst}📄 CodeRabbit inference engine (.agents/skills/contribute-api/SKILL.md)
Files:
**/*📄 CodeRabbit inference engine (.agents/skills/karpathy-guidelines/SKILL.md)
Files:
**/*.{md,mdx,rst}📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Files:
**/*.{md,rst,txt,adoc}📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-language-mechanics.md)
Files:
adapters/*/README.md📄 CodeRabbit inference engine (AGENTS.md)
Files:
**/*.{md,mdx}📄 CodeRabbit inference engine (CONTRIBUTING.md)
Files:
**/*.{rs,py,html,md,mdx,toml,yaml,yml,sh,bash}📄 CodeRabbit inference engine (CONTRIBUTING.md)
Files:
adapters/*/{README.md,LICENSE,fabric-adapter.json,pyproject.toml,uv.lock,package.json,package-lock.json,src/**,tests/**}📄 CodeRabbit inference engine (.agents/skills/contribute-adapter/SKILL.md)
Files:
**/*.{md,mdx,yml,py,rs,sh}📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
Files:
{adapters/**,examples/**}⚙️ CodeRabbit configuration file
Files:
{*.md,**/*.md,**/*.mdx,**/*.ipynb}⚙️ CodeRabbit configuration file
Files:
🔇 Additional comments (1)
WalkthroughDocumentation links across adapters and package metadata now point to NVIDIA-hosted NeMo Fabric pages. Harbor setup instructions and integration expectations now pin the stable ChangesDocumentation and release updates
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Important Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional. ❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
Fern docs preview: https://nvidia-preview-pull-request-163.docs.buildwithfern.com/nemo/fabric |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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 `@adapters/claude/README.md`:
- Line 27: Replace all dead docs.nvidia.com/nemo/fabric links with their current
valid destinations across adapters/claude/README.md (installation, auth, and
Relay links), adapters/claude/pypi.md, adapters/claude/pyproject.toml
(Documentation metadata), adapters/codex/README.md, pypi.md, pyproject.toml
(Documentation metadata), python/README.md, python/pypi.md, and
python/pyproject.toml (Documentation metadata); update each referenced site,
including the listed line ranges, without changing unrelated content.
In `@adapters/codex/pypi.md`:
- Around line 28-30: The NeMo Fabric documentation links and package metadata
are stale; update all referenced documentation URLs to the live base URL
https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric with matching
installation-guide anchors. Apply the corresponding link updates in
adapters/codex/pypi.md (28-30), adapters/codex/pyproject.toml (44),
adapters/common/README.md (18), adapters/common/pypi.md (26),
adapters/common/pyproject.toml (32), adapters/deepagents/README.md (29),
adapters/deepagents/pypi.md (33), adapters/deepagents/pyproject.toml (56),
adapters/hermes/README.md (27), adapters/hermes/pypi.md (34), and
adapters/hermes/pyproject.toml (48), including each pyproject.toml Documentation
field.
🪄 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: 6e77e8f8-721f-4eee-917c-8185bff793b9
📒 Files selected for processing (22)
adapters/claude/README.mdadapters/claude/pypi.mdadapters/claude/pyproject.tomladapters/codex/README.mdadapters/codex/pypi.mdadapters/codex/pyproject.tomladapters/common/README.mdadapters/common/pypi.mdadapters/common/pyproject.tomladapters/deepagents/README.mdadapters/deepagents/pypi.mdadapters/deepagents/pyproject.tomladapters/hermes/README.mdadapters/hermes/pypi.mdadapters/hermes/pyproject.tomlexamples/harbor/swebench/README.mdpypi.mdpyproject.tomlpython/README.mdpython/pypi.mdpython/pyproject.tomltests/integrations/test_harbor_runner.py
📜 Review details
🧰 Additional context used
📓 Path-based instructions (37)
**/*
📄 CodeRabbit inference engine (.agents/skills/karpathy-guidelines/SKILL.md)
**/*: Before implementing, explicitly state assumptions, surface ambiguity and tradeoffs, present multiple interpretations when relevant, and ask for clarification rather than silently deciding or proceeding when requirements are unclear.
Prefer the minimum code needed to solve the requested problem: avoid speculative features, unnecessary abstractions, unrequested flexibility, and handling of impossible scenarios; simplify overcomplicated solutions.
When editing existing code, make surgical changes only: do not modify unrelated code, comments, formatting, or pre-existing dead code; match the existing style, and remove only unused imports, variables, or functions introduced by your changes.
Define verifiable success criteria for each task, such as writing regression tests for bugs and invalid-input tests for validation, then verify the implementation against those criteria. For multi-step work, state a brief plan with a verification check for each step.
**/*: Always spellNVIDIAin all caps; do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun, because the name begins with an “en” sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company; use trademark symbols with product names only when required by the document type or legal guidance.
Verify official capitalization, spacing, hyphenation, and spelling for NVIDIA and third-party product names; do not rewrite official product names for grammar or title-case rules.
Precede NVIDIA product names withNVIDIAon first mention when natural and accurate, and link the first mention when the destination helps the reader.
On first use, include the company name and full model qualifier when it helps identify the model; preserve official capitalization and punctuation, and use shorter family names only after establishing the full name.
For learning-oriented and developer content, do not force trademark symbols unless explicitly required; for press, ...
Files:
adapters/common/pyproject.tomladapters/hermes/README.mdadapters/common/pypi.mdadapters/claude/pyproject.tomladapters/hermes/pyproject.tomladapters/deepagents/README.mdpython/README.mdadapters/codex/pypi.mdadapters/deepagents/pypi.mdadapters/hermes/pypi.mdpython/pypi.mdadapters/claude/pypi.mdpyproject.tomlpython/pyproject.tomladapters/codex/pyproject.tomladapters/common/README.mdexamples/harbor/swebench/README.mdadapters/deepagents/pyproject.tomladapters/codex/README.mdpypi.mdtests/integrations/test_harbor_runner.pyadapters/claude/README.md
**/*.{rs,toml}
📄 CodeRabbit inference engine (.agents/skills/prepare-pr/SKILL.md)
For any Rust change, run
just test-rustandcargo fmt --all -- --check.For Rust core, CLI, or shared runtime semantic changes, run Rust formatting and tests, and add Python tests when behavior is exposed through the SDK.
Files:
adapters/common/pyproject.tomladapters/claude/pyproject.tomladapters/hermes/pyproject.tomlpyproject.tomlpython/pyproject.tomladapters/codex/pyproject.tomladapters/deepagents/pyproject.toml
**/{Cargo.toml,Cargo.lock,pyproject.toml,package.json}
📄 CodeRabbit inference engine (.agents/skills/prepare-pr/SKILL.md)
For new or updated dependencies, document the functional need, alternatives considered, and why the selected dependency is the narrowest fit.
Files:
adapters/common/pyproject.tomladapters/claude/pyproject.tomladapters/hermes/pyproject.tomlpyproject.tomlpython/pyproject.tomladapters/codex/pyproject.tomladapters/deepagents/pyproject.toml
**/*.{toml,lock}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If a manifest or lockfile changes, run the license-diff script against
origin/main, review transitive license changes, and run theattributions-rustandattributions-pythonpre-commit hooks.
Files:
adapters/common/pyproject.tomladapters/claude/pyproject.tomladapters/hermes/pyproject.tomlpyproject.tomlpython/pyproject.tomladapters/codex/pyproject.tomladapters/deepagents/pyproject.toml
**/*.{yml,yaml,toml,lock}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
For CI or packaging changes, use
maintain-ciormaintain-packaging, then run recipes and checks whose behavior changed.
Files:
adapters/common/pyproject.tomladapters/claude/pyproject.tomladapters/hermes/pyproject.tomlpyproject.tomlpython/pyproject.tomladapters/codex/pyproject.tomladapters/deepagents/pyproject.toml
{pyproject.toml,adapters/**/pyproject.toml}
📄 CodeRabbit inference engine (.agents/skills/update-project-version/SKILL.md)
{pyproject.toml,adapters/**/pyproject.toml}: Update the literalproject.versionin the root setuptools project and every adapterpyproject.toml.
Keep internal exact-version requirements aligned: rootnemo-fabric-* == <version>optional dependencies and each adapter'snemo-fabric-adapters-common == <version>dependency.
Files:
adapters/common/pyproject.tomladapters/claude/pyproject.tomladapters/hermes/pyproject.tomlpyproject.tomladapters/codex/pyproject.tomladapters/deepagents/pyproject.toml
**/*.{rs,py,toml}
📄 CodeRabbit inference engine (.agents/skills/update-project-version/SKILL.md)
When editing version helpers, verify every
nemo-fabric-*workspace package through Cargo metadata and reject a static version inpython/pyproject.toml.
Files:
adapters/common/pyproject.tomladapters/claude/pyproject.tomladapters/hermes/pyproject.tomlpyproject.tomlpython/pyproject.tomladapters/codex/pyproject.tomladapters/deepagents/pyproject.tomltests/integrations/test_harbor_runner.py
**/*.{toml,rs,py}
📄 CodeRabbit inference engine (.agents/skills/update-project-version/SKILL.md)
Avoid blind repository-wide replacement of version-like strings; distinguish package-version references from examples and unrelated dependency versions.
Files:
adapters/common/pyproject.tomladapters/claude/pyproject.tomladapters/hermes/pyproject.tomlpyproject.tomlpython/pyproject.tomladapters/codex/pyproject.tomladapters/deepagents/pyproject.tomltests/integrations/test_harbor_runner.py
**/*.{rs,py,html,md,mdx,toml,yaml,yml,sh,bash}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
All source files must include the specified SPDX copyright and Apache-2.0 license headers using the comment syntax appropriate to the file type.
Files:
adapters/common/pyproject.tomladapters/hermes/README.mdadapters/common/pypi.mdadapters/claude/pyproject.tomladapters/hermes/pyproject.tomladapters/deepagents/README.mdpython/README.mdadapters/codex/pypi.mdadapters/deepagents/pypi.mdadapters/hermes/pypi.mdpython/pypi.mdadapters/claude/pypi.mdpyproject.tomlpython/pyproject.tomladapters/codex/pyproject.tomladapters/common/README.mdexamples/harbor/swebench/README.mdadapters/deepagents/pyproject.tomladapters/codex/README.mdpypi.mdtests/integrations/test_harbor_runner.pyadapters/claude/README.md
adapters/*/{README.md,LICENSE,fabric-adapter.json,pyproject.toml,uv.lock,package.json,package-lock.json,src/**,tests/**}
📄 CodeRabbit inference engine (.agents/skills/contribute-adapter/SKILL.md)
Place each adapter under
adapters/<name>withLICENSE -> ../../LICENSE,README.md,fabric-adapter.json, language-native package and lock files, a source entry point, and focused tests; Python adapters use the specifiedpyproject.toml,uv.lock, source path, and test naming convention.
Files:
adapters/common/pyproject.tomladapters/hermes/README.mdadapters/claude/pyproject.tomladapters/hermes/pyproject.tomladapters/deepagents/README.mdadapters/codex/pyproject.tomladapters/common/README.mdadapters/deepagents/pyproject.tomladapters/codex/README.mdadapters/claude/README.md
adapters/*/pyproject.toml
📄 CodeRabbit inference engine (.agents/skills/contribute-adapter/SKILL.md)
Keep published Python runtime dependencies razor-thin and adapter-owned; directly imported SDK/client libraries must be declared, while external-process harness dependencies must not be installed or upgraded and test-only dependencies belong in
[dependency-groups].
Files:
adapters/common/pyproject.tomladapters/claude/pyproject.tomladapters/hermes/pyproject.tomladapters/codex/pyproject.tomladapters/deepagents/pyproject.toml
{adapters/**,examples/**}
⚙️ CodeRabbit configuration file
{adapters/**,examples/**}: Review adapter and example changes for command correctness, config/schema consistency, artifact handling, and compatibility with the public NeMo Fabric contracts.
Files:
adapters/common/pyproject.tomladapters/hermes/README.mdadapters/common/pypi.mdadapters/claude/pyproject.tomladapters/hermes/pyproject.tomladapters/deepagents/README.mdadapters/codex/pypi.mdadapters/deepagents/pypi.mdadapters/hermes/pypi.mdadapters/claude/pypi.mdadapters/codex/pyproject.tomladapters/common/README.mdexamples/harbor/swebench/README.mdadapters/deepagents/pyproject.tomladapters/codex/README.mdadapters/claude/README.md
**/*.{md,rst}
📄 CodeRabbit inference engine (.agents/skills/contribute-api/SKILL.md)
Update documentation and examples in the same branch as the public API change.
Files:
adapters/hermes/README.mdadapters/common/pypi.mdadapters/deepagents/README.mdpython/README.mdadapters/codex/pypi.mdadapters/deepagents/pypi.mdadapters/hermes/pypi.mdpython/pypi.mdadapters/claude/pypi.mdadapters/common/README.mdexamples/harbor/swebench/README.mdadapters/codex/README.mdpypi.mdadapters/claude/README.md
**/*.{md,mdx,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,mdx,rst}: For NeMo Fabric documentation, verify technical claims against the current repository, public API, or documented command before reviewing style.
Always spellNVIDIAin all caps; do not useNvidia,nvidia, orNV.
Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text; avoid raw URLs and weak anchors such ashereorread more.
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative, parallel steps; split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English while preserving necessary technical precision.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce, and preferrefer tooverseewhen directing readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical documentation.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values; use numerals for 10 or greater and commas in thousands.
Do not add trademark symbols to learning-oriented documentation unless the source, platform, or legal guidance explicitly requires them.
Do not replace precise technical terms with simpler words when doing so would lose precision.
Do not flag passive voice when the actor is unknown or the action is the important part.
Do not rewrite API names, package names, command flags, or code literals for style.
**/*.{md,mdx,rst}: Use consistent title case for technical-document headings and table headers; avoid quotation marks, ampersands, and exclamation marks in headings, while preserving official product, event, research, and whitepaper title ...
Files:
adapters/hermes/README.mdadapters/common/pypi.mdadapters/deepagents/README.mdpython/README.mdadapters/codex/pypi.mdadapters/deepagents/pypi.mdadapters/hermes/pypi.mdpython/pypi.mdadapters/claude/pypi.mdadapters/common/README.mdexamples/harbor/swebench/README.mdadapters/codex/README.mdpypi.mdadapters/claude/README.md
**/*.{md,rst,txt,adoc}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-language-mechanics.md)
**/*.{md,rst,txt,adoc}: For technical documentation, use professional, active, conversational, engaging, precise, and plain-English prose. Prefer active voice, present tense, short sentences, and scannable paragraphs. Avoid casual or imprecise language, swearing, threats, insults, jokes, puns, culture-specific idioms, marketing exaggeration, and unsupported third-party comparisons.
Usecanfor possibility and reservemayfor permission; useafterfor temporal order; userefer tofor cross-references; prefer short direct sentences and specific verbs; avoid unnecessarypleasein technical documentation.
Prefer active voice when the actor matters. Passive voice is acceptable when the actor is unknown or irrelevant, when the action or result is the focus, or in programmer documentation.
Use natural contractions in conversational technical prose, but do not force them in formal legal copy, API references, or generated text.
Prefer simpler English over Latinisms: usefor exampleorsuch asinstead ofe.g.,and so oninstead ofetc.,that isinstead ofi.e.,compared toinstead ofvs., andby,through, orusinginstead ofvia. Use industry-standard terms such as in silico, in vitro, and in vivo when appropriate, and italicize them in running text.
Usethatwithout commas for essential clauses, andwhichwith commas for nonessential clauses.
Format dates and times clearly: spell out months in body text; use forms such asJune 12, 2025; avoid numeric or ordinal dates; capitalize days; use 12-hour time when appropriate; include a space beforea.m.orp.m.; useETandPTfor needed time zones; avoid24/7; and preferfrom 12:30 to 1:00 p.m.for prose ranges.
Format numbers consistently: spell out zero through nine in body text, use numerals for 10 or greater and for technical values, use commas in thousands, do not begin a sentence with a numeral, spell out ordinals, and use numerals consistently within a category wh...
Files:
adapters/hermes/README.mdadapters/common/pypi.mdadapters/deepagents/README.mdpython/README.mdadapters/codex/pypi.mdadapters/deepagents/pypi.mdadapters/hermes/pypi.mdpython/pypi.mdadapters/claude/pypi.mdadapters/common/README.mdexamples/harbor/swebench/README.mdadapters/codex/README.mdpypi.mdadapters/claude/README.md
adapters/*/README.md
📄 CodeRabbit inference engine (AGENTS.md)
Update adapter integration READMEs when public behavior, examples, or supported bindings change.
Document installation, supported configuration, harness-only settings, credentials, lifecycle, telemetry, artifacts, limitations, focused test commands, and canonical typed SDK or harness-native YAML examples where applicable.
Files:
adapters/hermes/README.mdadapters/deepagents/README.mdadapters/common/README.mdadapters/codex/README.mdadapters/claude/README.md
**/*.{md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
When public behavior, adapters, examples, or workspace structure changes, update the corresponding documentation, including relevant README files and SDK or API references.
**/*.{md,mdx}: Use the full product nameNVIDIA NeMo Fabricon first use, typically in the title and H1; useNeMo Fabricthereafter. Usefabricalone only for the CLI tool and surround it with backticks.
Treat incorrect or stale commands, package names, paths, APIs, support claims, procedures, examples, terminology, or public behavior documentation as blocking issues.
CapitalizeNVIDIAcorrectly and format code, commands, paths, and filenames as inline code where needed.
Use title case for technical-documentation headings.
Introduce code blocks, tables, and lists with complete lead-in sentences; ensure examples match current APIs and build commands.
Use descriptive anchor text, avoid raw URLs and generic labels such ashere, and use repository-relative.mdxpaths for links withindocs/.
Prefer active voice, present tense, short sentences, plain English, consistent terminology, and imperative, parallel, scannable procedures.
Useafterinstead ofoncewhen expressing temporal sequence, and usecanrather thanmaywhen describing possibility rather than permission.
Avoid ambiguous numeric dates and ordinal dates in body text.
For learning-oriented documentation, do not force trademark symbols unless the source document explicitly requires them.
When reporting documentation-review findings, lead withMust fix,Should fix, andNice to havecategories; include file path, line reference, current problem, rationale, and a concrete rewrite or direction.
Files:
adapters/hermes/README.mdadapters/common/pypi.mdadapters/deepagents/README.mdpython/README.mdadapters/codex/pypi.mdadapters/deepagents/pypi.mdadapters/hermes/pypi.mdpython/pypi.mdadapters/claude/pypi.mdadapters/common/README.mdexamples/harbor/swebench/README.mdadapters/codex/README.mdpypi.mdadapters/claude/README.md
**/*.{md,mdx,yml,py,rs,sh}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
Keep documentation aligned with current NeMo Fabric behavior, repository layout, entry points, commands, package names, APIs, bindings, and support claims.
Files:
adapters/hermes/README.mdadapters/common/pypi.mdadapters/deepagents/README.mdpython/README.mdadapters/codex/pypi.mdadapters/deepagents/pypi.mdadapters/hermes/pypi.mdpython/pypi.mdadapters/claude/pypi.mdadapters/common/README.mdexamples/harbor/swebench/README.mdadapters/codex/README.mdpypi.mdtests/integrations/test_harbor_runner.pyadapters/claude/README.md
{*.md,**/*.md,**/*.mdx,**/*.ipynb}
⚙️ CodeRabbit configuration file
{*.md,**/*.md,**/*.mdx,**/*.ipynb}: Enforce the product name in user-facing prose: use "NVIDIA NeMo Fabric" on first use and "NeMo Fabric" thereafter. Flag standalone capitalized "Fabric" when it refers to the product. Do not flag the lowercasefabricCLI command, package/import/crate names, code identifiers, API symbols, configuration keys, file paths, or unrelated generic uses of the word.
Files:
adapters/hermes/README.mdadapters/common/pypi.mdadapters/deepagents/README.mdpython/README.mdadapters/codex/pypi.mdadapters/deepagents/pypi.mdadapters/hermes/pypi.mdpython/pypi.mdadapters/claude/pypi.mdadapters/common/README.mdexamples/harbor/swebench/README.mdadapters/codex/README.mdpypi.mdadapters/claude/README.md
{Cargo.toml,python/pyproject.toml,pyproject.toml}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Keep Rust workspace/package metadata and Python/maturin package metadata internally consistent, including package names, versions, import paths, and module names.
Files:
pyproject.tomlpython/pyproject.toml
{Cargo.toml,Cargo.lock,pyproject.toml,uv.lock,python/pyproject.toml}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
{Cargo.toml,Cargo.lock,pyproject.toml,uv.lock,python/pyproject.toml}: Keep workspace, Python, and lockfile dependency versions aligned where required, and review both direct and transitive dependency changes from resolved lockfiles.
Inspect resolved transitive licenses, explicitly surface UNKNOWN, non-SPDX/custom, proprietary, source-available, copyleft, or network-copyleft terms, and route unresolved licensing questions to dependency approvers with distribution and linkage context.
Document the functional need, alternatives considered, rationale for the selected dependency, and any unresolved licensing question when introducing dependencies.
Files:
pyproject.tomlpython/pyproject.toml
{Cargo.toml,pyproject.toml,python/pyproject.toml}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Before adding a dependency, prefer the standard library, an existing dependency, or a small local implementation when appropriate; otherwise select a maintained, narrow-fit dependency with clear SPDX metadata and a permissive license where possible.
Files:
pyproject.tomlpython/pyproject.toml
{Cargo.toml,Cargo.lock,pyproject.toml,uv.lock}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
After updating manifests or lockfiles, run
uv run --no-project python scripts/licensing/license_diff.py --base-ref origin/mainand review added packages and license changes.
Files:
pyproject.toml
{pyproject.toml,python/pyproject.toml,Cargo.toml,docs/package.json,.github/workflows/*.yml,justfile}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Reflect public packaging changes in release-facing documentation and ensure CI references the same package names and commands used by local workflows.
Files:
pyproject.tomlpython/pyproject.toml
python/pyproject.toml
📄 CodeRabbit inference engine (.agents/skills/update-project-version/SKILL.md)
Keep
project.dynamic = ["version"]; do not add a literalproject.version, because Maturin derives the runtime version from Cargo metadata.
Files:
python/pyproject.toml
{README.md,docs/**/*.{md,mdx,yml},examples/**/*.{md,mdx,yml}}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep package names, repository references, and build commands current in documentation and examples.
Files:
examples/harbor/swebench/README.md
{docs/**/*.{md,mdx,yml},examples/**/*.{md,mdx,yml}}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Update relevant getting-started, reference, adapter, and example documentation when the corresponding examples or adapters change.
Files:
examples/harbor/swebench/README.md
examples/{README.md,**/*}
📄 CodeRabbit inference engine (AGENTS.md)
Update examples documentation and relevant examples when public behavior, the package, or supported bindings change.
Files:
examples/harbor/swebench/README.md
**/*.{rs,py,pyi,json,yaml,yml}
📄 CodeRabbit inference engine (.agents/skills/contribute-api/SKILL.md)
Determine and update every affected public surface, including the CLI, PyO3 bindings, Python SDK, type stubs, schemas, and adapter contract, so they remain in parity.
Files:
tests/integrations/test_harbor_runner.py
**/*.{rs,py}
📄 CodeRabbit inference engine (.agents/skills/prepare-pr/SKILL.md)
For native binding changes, run
cargo check -p fabric-python --locked.
**/*.{rs,py}: Usesnake_casefor functions and variables; usePascalCasefor Rust types and Python classes.
Run the relevant Rust and Python test suites for every affected language surface; changes to the Rust core or public schemas require both suites.
Files:
tests/integrations/test_harbor_runner.py
**/*.{py,pyi}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If Python code or a Python-facing adapter changes, run
just test-python.
Files:
tests/integrations/test_harbor_runner.py
**/*.{rs,py,pyi}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
**/*.{rs,py,pyi}: If public configuration types change, confirm schema snapshot tests injust test-rustpass and review generated schema diffs.
For schema or public contract changes, run both language suites and review changes underschemas/and generated API references.
Files:
tests/integrations/test_harbor_runner.py
**/*.{py,pyi,rs}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
For Python SDK or PyO3 binding changes, use
python-tests, run focused pytest tests first, thenjust test-python; rebuild withjust build-pythonwhen native code or packaging changes.
Files:
tests/integrations/test_harbor_runner.py
tests/**/*.py
📄 CodeRabbit inference engine (.agents/skills/python-tests/SKILL.md)
tests/**/*.py: Use Pytest to run Python tests.
Do not add@pytest.mark.asyncioto tests; async tests are automatically detected and run by the async runner.
Do not add-> Nonereturn type annotations to test functions.
When mocking a class, useunittest.mock.MagicMockorunittest.mock.AsyncMock, using thespecargument when necessary, rather than defining a new class.
Prefix mocked class names withmock, notfake.
Prefer pytest fixtures over helper methods.
Do not repeat fixtures; place fixtures needed by multiple test files inconftest.py.
Define fixtures using@pytest.fixture(name="<fixture_name>"[, scope="<scope>"])and a function named<fixture_name>_fixture; specifyscopeonly when it is notfunction.
Preferpytest.mark.parametrizeover separate tests for different input types.
Use@pytest.mark.usefixtureswhen a fixture is needed but its return value is unused or it does not return a value.
Use the autouserestore_environ_fixturefromtests/conftest.pyto restore environment variables; modify variables withos.environand do not usemonkeypatch.setenv.
Avoid defensive programming in tests; access expected data directly so missing data raises a clear failure, such as usingresults["data"]instead ofresults.get("data").
Files:
tests/integrations/test_harbor_runner.py
**/*.py
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Use type annotations for public Python APIs and keep native binding declarations synchronized with their Rust implementations.
Files:
tests/integrations/test_harbor_runner.py
**/*.{rs,py,json}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
When adding functionality, include tests in the corresponding Rust crate or relevant
tests/area; public contract changes must keep checked-in JSON Schema snapshots and native Python binding declarations synchronized.
Files:
tests/integrations/test_harbor_runner.py
{tests/**,python/tests/**}
⚙️ CodeRabbit configuration file
{tests/**,python/tests/**}: Tests should cover the behavior promised by the changed API surface, including error paths, lifecycle cleanup, and SDK/native parity where relevant.
Files:
tests/integrations/test_harbor_runner.py
🔇 Additional comments (2)
examples/harbor/swebench/README.md (1)
30-30: 🩺 Stability & AvailabilityVerify that
nemo-fabric==0.1.0is available from Harbor’s package index.The public PyPI endpoint for this exact release currently returns 404. Because
FABRIC_PACKAGEis passed to the installation flow, Harbor will fail unless it resolves dependencies from another index containing0.1.0. ()As per coding guidelines, examples must remain aligned with current package names and build commands.
Source: Coding guidelines
tests/integrations/test_harbor_runner.py (1)
333-333: LGTM!
Signed-off-by: David Gardner <dagardner@nvidia.com>
|
/merge |
Overview
Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Closes FABRIC-135
I confirm this contribution is my own work, or I have the right to submit it under this project's license.
I searched existing issues and open pull requests, and this does not duplicate existing work.
Summary by CodeRabbit
Documentation
0.1.0package release instead of a pre-release version.Tests