Menú
Contribution conventions for NeMo-RL. Covers PR title format, commit sign-off, and CI triggering.
Build and dependency management for NeMo-RL. Covers Docker image building and running, uv usage, venv setup, and adding dependencies.
CI/CD reference for NeMo-RL. Covers GitHub Actions pipeline structure, CI triggering via /ok to test, and CI failure investigation.
Configuration conventions for NeMo-RL. YAML is the single source of truth for defaults. Covers TypedDict usage, exemplar YAML updates, and forbidden default patterns.
NVIDIA copyright header requirements for NeMo-RL. Covers which files need headers and the exact header text.
Documentation conventions for NeMo-RL. Covers docs/index.md updates and docstring format.
Error handling guidelines for NeMo-RL. Covers exception specificity, minimal try bodies, and else blocks.
| name | contributing |
| description | Contribution conventions for NeMo-RL. Covers PR title format, commit sign-off, and CI triggering. |
| when_to_use | Opening a PR; writing a commit message; triggering CI; 'PR title format', 'sign-off', 'conventional commits', 'how do I trigger CI', during code review of PR process. |
PR titles must follow the Conventional Commits spec. This is enforced by the semantic-pull-request CI check.
<type>[optional scope]: <description>
Allowed types:
| Type | When to use |
|---|---|
feat | New feature |
fix | Bug fix |
ci | CI/CD changes |
docs | Documentation only |
refactor | Code restructuring without behaviour change |
test | Adding or fixing tests |
chore | Maintenance (deps, configs, tooling) |
perf | Performance improvement |
build | Build system changes |
revert | Reverts a previous commit |
Do:
ci: retry apt-get installs to handle mirror sync failures
feat(grpo): add dataclass config defaults infrastructure
fix: preserve RAY_EXPERIMENTAL_NOSET_CUDA_VISIBLE_DEVICES
Don't:
[ci] fix: retry apt-get installs ← area tags are not part of this convention
Update stuff
Fix bug
All commits must be signed off with -s:
git commit -s -m "fix: correct reward normalization"
After pushing, trigger CI with:
/ok to test <full-commit-sha>
Use git rev-parse HEAD (not the short form) to get the full SHA.