agentleFS
Sign inStart free
NVIDIAKnown publisherNVIDIA/NeMo-Fabric/.agents/skills/contribute-api/SKILL.md

contribute-api

Skill73 starsChanged 58 days agoApache-2.0View on GitHub

Contribute a new NVIDIA NeMo Fabric public API surface safely, with Rust, CLI, Python, TypeScript, schema, adapter, and documentation parity in mind

The file

We split this skill into the rules it gives an agent

6 rules. About 0 are common, 5 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use karpathy-guidelines alongside this skill for implementation or review work.

    line 13
  2. Distinctive:

    Use this skill when contributing a public API addition or behavior change to the runtime or bindings.

    line 17
  3. Distinctive:

    Start from the shared Rust core behavior first

    line 22
  4. Distinctive:

    Keep every affected public surface in parity

    line 25
  5. Distinctive:

    Update docs and examples in the same branch

    line 28
  6. Distinctive:

    Every affected public surface is covered

    line 33

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Contribute A New API Surface

Companion Guidance

Use karpathy-guidelines alongside this skill for implementation or review work. Keep changes scoped, surface assumptions, and define focused validation before editing.

Use this skill when contributing a public API addition or behavior change to the runtime or bindings.

Default Guidance

  • Start from the shared Rust core behavior first
  • Decide whether the CLI, PyO3 binding, Python SDK, type stubs, schemas, or the Python and TypeScript adapter-contract bindings must expose the new surface
  • Keep every affected public surface in parity
  • RunRequest.relay_session_root is forwarded as the typed AgentRunRequest.relay_session_root field. Keep Rust, Python, TypeScript, and schema representations in parity. Context keys do not control Relay propagation; preserve the adapter fallback for unusable UUIDs.
  • OpenShell task commands serialize public SDK config/request/handle/result mappings. Keep forwarding buffered and preserve task-generated IDs, normalized failed results, telemetry references, and declared artifacts. Do not normalize an SDK result as an adapter result. Task paths remain POSIX strings; host artifact destinations stay separate. Unknown outcomes bind the immutable sandbox identity through reattachment and must not be replayed.
  • Update docs and examples in the same branch

Minimum Acceptance

  • Public behavior is clearly described
  • Every affected public surface is covered
  • The validation matrix matches the changed surfaces
  • PR notes explain the user-facing change

References

  • validate-change
  • review-doc-style
  • docs/python-sdk-contract.md
  • schemas/SCHEMA.md
  • justfile
  • Software provenance uses FabricConfig.provenance and optional RunResult.execution. Keep Rust, shared Python evidence dataclasses in nemo-fabric-evidence, SDK result mappings, generated TypeScript types and the canonical schemas/evidence/execution-evidence.schema.json aligned. The shared schema is generated from Rust and consumed by both NB and SB bindings; keep the TypeScript adapter-contract schema copy byte-identical. Preserve strict adapter result shapes: lifecycle evidence is carried beside the outcome. Optional report failure must not replace invocation outcomes.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free