agentleFS
NVIDIAKnown publisherNVIDIA/simready-foundation/.agents/skills/simready-foundation-add-requirement/SKILL.md

simready-foundation-add-requirement

Skill156 starsChanged 52 days agoApache-2.0View on GitHub

Use for adding atomic SimReady requirements with stable IDs, docs, examples, indexes, and validator follow-up.

The file

Show its rules and text

We split this skill into the rules it gives an agent

16 rules. About 0 are common, 10 are distinctive, and 6 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈10

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 6

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this skill to add one new atomic, testable requirement to an existing SimReady capability.

    line 17
  2. Very specific:

    If no existing capability fits, use simready-foundation-add-capability first.

    line 19
  3. Distinctive:

    Use this checklist when changing the repository:

    line 49
  4. Very specific:

    Create requirements/<requirement_slug>.md using the repository's requirement metadata table style: Code, Validator, Compatibility, and Tags.

    line 52
  5. Distinctive:

    Add valid and invalid examples that show the smallest meaningful pass/fail distinction.

    line 54
  6. Very specific:

    Add the requirement filename to the capability requirements.md toctree or requirements table.

    line 55
  7. Very specific:

    If the capability overview lists requirements directly, update capability-<slug>.md too.

    line 56
  8. Very specific:

    If an objective rule can be implemented now, hand off to simready-foundation-add-validator.

    line 57
  9. Very specific:

    If an existing or new feature should include this requirement, hand off to simready-foundation-add-feature or …

    line 58
  10. Distinctive:

    Do not create a requirement just to mirror a feature name.

    line 84
  11. Distinctive:

    Prefer native USD concepts before custom metadata.

    line 85
  12. Distinctive:

    Use warnings or manual review for subjective guidance.

    line 87
  13. Distinctive:

    Do not list a requirement in a feature until its intended validation status is clear.

    line 88
  14. Distinctive:

    Do not mutate published feature or profile versions in place.

    line 92
  15. Distinctive:

    Do not invent requirement IDs or validator behavior when the contract is ambiguous.

    line 93
  16. Distinctive:

    Do not skip index, manifest, validation, or downstream follow-up notes.

    line 94

≈ “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

SimReady Add Requirement

Purpose

Use this skill to add one new atomic, testable requirement to an existing SimReady capability. A requirement is the smallest stable contract that features can include and validators can report.

If no existing capability fits, use simready-foundation-add-capability first. If the requirement changes behavior for an existing rule, use simready-foundation-update-requirement.

Prerequisites

Before editing, read:

  • AGENTS.md
  • nv_core/sr_specs/docs/guides/guides.md
  • nv_core/sr_specs/docs/guides/features/features.md
  • nv_core/sr_specs/docs/guides/features_expansion_workflow.md
  • nv_core/sr_specs/docs/guides/naming_conventions.md
  • target capability capability-*.md, requirements.md, existing requirements/*.md, and validation.py

Inputs

Collect or infer:

InputRequirement
capability_pathExisting capability folder under its owning tier's capabilities/ directory.
requirement_slugKebab-case filename without .md.
requirement_codeStable code such as RB.011 or NVM.006; must not already exist.
summaryOne-sentence rule statement.
descriptionPrecise asset condition being checked.
compatibilityOpenUSD, PhysX, Isaac Sim, MDL, or other relevant compatibility tier.
tagsEssential, correctness, portability, performance, or another existing tag.
examplesValid and invalid USDA or structured examples.
validator_planExisting validator, new validator needed, manual-only, or runtime-only.

Instructions

Use this checklist when changing the repository:

  1. Confirm the target capability exists and the requirement code is unused across all tier capability sources.
  2. Create requirements/<requirement_slug>.md using the repository's requirement metadata table style: Code, Validator, Compatibility, and Tags.
  3. Include Summary, Description, Why, Examples, How to comply, and relevant USD or runtime references.
  4. Add valid and invalid examples that show the smallest meaningful pass/fail distinction.
  5. Add the requirement filename to the capability requirements.md toctree or requirements table.
  6. If the capability overview lists requirements directly, update capability-<slug>.md too.
  7. If an objective rule can be implemented now, hand off to simready-foundation-add-validator.
  8. If an existing or new feature should include this requirement, hand off to simready-foundation-add-feature or simready-foundation-update-feature.
  9. Validate consistency:
    • requirement code is unique
    • requirement file is reachable from the capability index
    • examples align with the described rule
    • validator status is stated honestly

Examples

Example request:

Add a new atomic requirement for factory connection point direction metadata.

Expected result summary:

changed_files: new docs, manifests, indexes, or validation scaffolding
validation: focused static checks and any relevant docs/build checks
remaining_gaps: requirement, validator, adapter, profile, or runtime-test follow-up

Policies

  • Requirements must be atomic. Split compound rules into separate requirement IDs.
  • Do not create a requirement just to mirror a feature name; define the concrete asset rule.
  • Prefer native USD concepts before custom metadata.
  • Any new custom USD property or attribute named by the requirement must follow naming_conventions.md namespace rules.
  • Use warnings or manual review for subjective guidance; reserve failures for objective contract violations.
  • Do not list a requirement in a feature until its intended validation status is clear.

Limitations

  • Do not mutate published feature or profile versions in place.
  • Do not invent requirement IDs or validator behavior when the contract is ambiguous; record the question.
  • Do not skip index, manifest, validation, or downstream follow-up notes.

Troubleshooting

  • Error: the new concept overlaps an existing artifact. Solution: update the existing capability, requirement, feature, profile, or adapter instead.
  • Error: names or IDs conflict. Solution: re-check naming conventions and nearby indexes before editing further.
  • Error: validation strategy is unclear. Solution: document deferred validation and the exact follow-up skill.

Resources

  • assets/openai.yaml preserves optional UI metadata for clients that read skill display hints. It is not required for the workflow.

Summary Format

Report:

FieldMeaning
requirement_codeNew requirement ID.
requirement_docMarkdown path.
capabilityCapability folder updated.
index_updatesRequirement index/overview files updated.
validator_planNew validator, existing validator, manual review, or runtime test.
feature_followupFeature(s) that should include the requirement.
validationChecks run and remaining gaps.

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.