| name | omniverse-asset-to-usd-contributing |
| description | Use when a user asks to modify, test, document, package, or review code changes for the usd-convert-asset repository, CLI, Python package, wheel staging, or smoke tests. |
| version | 0.1.0 |
| license | Apache-2.0 AND CC-BY-4.0 |
| metadata | {"author":"NVIDIA Corporation","tags":["omniverse","openusd","converter","contributing","packaging"]} |
| tools | ["Read","Edit","Shell"] |
Contributing - Omniverse Asset to USD
Purpose
Guide code, packaging, documentation, and test changes for the usd-convert-asset repository without mixing contributor workflow into the end-user conversion skill.
When to Use
Use this module when a user asks to change converter implementation, CLI arguments, package metadata, wheel staging, smoke tests, build docs, release notes, or repository contribution workflow.
For installing or building the package, load ../omniverse-asset-to-usd-getting-started/SKILL.md. For running conversions or choosing CLI flags, load ../omniverse-asset-to-usd-asset-conversion/SKILL.md.
Read First
Before editing, identify the change type and read the local implementation:
| Change type | Read first |
|---|
| CLI behavior | source/python/usd_convert_asset/cli.py |
| Module entry point | source/python/usd_convert_asset/__main__.py |
| Package metadata | source/python/templates/pyproject.toml |
| Wheel staging | source/python/premake5.lua and source/python/hatch_build.py |
| Smoke tests | source/python/tests/test_pip_wheel_smoke.py |
| Build and install docs | README.md, source/python/README.md, CONTRIBUTING.md |
Keep CLI examples, README snippets, and smoke tests aligned when flags, entry points, install flow, package metadata, or staging behavior change.
Hard Rules
- Do not import native bindings from
usd_convert_asset.__init__; package import should stay lightweight.
- Keep both entry points working when CLI behavior changes:
usd-convert-asset and python -m usd_convert_asset.
- For source-build or wheel-staging changes, account for platform-specific native runtime libraries and plugin resources.
- Do not commit machine-local Autodesk FBX SDK paths or accept Autodesk license terms on behalf of the user.
Verification
Use the smallest verification that covers the changed surface:
| Change | Verification |
|---|
| CLI argument parsing or conversion flow | usd-convert-asset --help and a small asset conversion |
python -m usd_convert_asset entry point | python -m usd_convert_asset --help |
| Wheel metadata or native runtime staging | Build a wheel from the staged _build/<platform>/<config>/pip/usd_convert_asset tree, install it into a clean venv, then import usd_convert_asset and asset_converter_native_bindings |
| Smoke test changes | python -m unittest discover -s source/python/tests -p "test_pip_wheel_smoke.py" -v after installing the wheel |
| Build or contribution docs | Check changed commands against README.md, source/python/README.md, and CONTRIBUTING.md |
Output
When done, summarize changed files, relevant verification, and any build/test steps that could not be run locally.
