Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (33 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

49 lines (33 loc) · 1.75 KB

Contributing To NeMo-Gym

Welcome to NeMo Gym! Help advance RL training for the community by contributing to NeMo Gym.

High Priority Contributions

New Environments

  • Novel training environments (coding, reasoning, tool use, games, and so on)
  • Benchmark integrations (SWE-Bench, Tau Bench, and so on)

Refer to the Environment Contribution Guide for detailed guidance.

RL Framework Integrations

  • Integration for new RL training frameworks (TRL, SkyRL, and so on)

Refer to the RL Framework Integration Guide for detailed guidance.

Always Welcome

  • Documentation and Tutorials
  • Bug Fixes
  • Features and Enhancements

Before Contributing

  • Bug reports: Include reproduction steps and environment details
  • Features and breaking changes: Open an issue to discuss before implementing
  • Environment behavior changes: Require careful consideration as they affect versioning and result comparability

Not sure where to start? Refer to our open issues or create a new issue to discuss your idea.

Development Setup

For complete development setup, CI/CD requirements, commit signing, and troubleshooting, refer to the Development Setup Guide.

Quick start:

git clone git@github.com:NVIDIA-NeMo/Gym.git
cd Gym
uv venv --python 3.12 && source .venv/bin/activate
uv sync --extra dev --group docs
pre-commit install

Important: All commits must be signed with DCO sign-off (-s) and cryptographic signature (-S):

git commit -s -S -m "Your commit message"