Skip to content

docs: add contributing guide with development setup and PR guidelines - #188

Merged
foreverlms merged 1 commit into
NVIDIA:mainfrom
zichen0116:docs/add-contributing-guide
Jun 5, 2026
Merged

docs: add contributing guide with development setup and PR guidelines#188
foreverlms merged 1 commit into
NVIDIA:mainfrom
zichen0116:docs/add-contributing-guide

Conversation

@zichen0116

Copy link
Copy Markdown
Contributor

Summary

This PR adds a CONTRIBUTING.md to help new contributors get started with the NVIDIA Cosmos project.

What it covers

  • Reporting issues -- guidance on what to include when filing bugs (environment details, repro steps, logs)
  • Pull request workflow -- fork, branch, test, commit, and PR guidelines
  • Development setup -- prerequisites (Python 3.10+, CUDA 12.8/13.x, uv >= 0.11.3) and quickstart steps
  • Contribution areas -- cookbooks/examples, documentation, bug fixes, and benchmarks
  • License -- clarifies that contributions fall under the OpenMDW-1.1 license

Motivation

The repository currently has no contributing guide or .github directory. A CONTRIBUTING.md lowers the barrier for first-time contributors and sets clear expectations for PR quality and scope, which is especially valuable as the project grows following the Cosmos 3 release.

Add a CONTRIBUTING.md that covers:
- How to report issues with environment details
- Pull request workflow and guidelines
- Development setup prerequisites (Python, CUDA, uv)
- Contribution areas (cookbooks, docs, bug fixes, benchmarks)
- License agreement (OpenMDW-1.1)
@foreverlms
foreverlms merged commit 1b87f59 into NVIDIA:main Jun 5, 2026
@foreverlms

Copy link
Copy Markdown
Collaborator

Thanks for this PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants