// Contribution conventions for NeMo-RL. Covers PR title format, commit sign-off, and CI triggering.
| 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.
Autonomous NeMo-RL research agent workflow for directed hypothesis testing and open-ended discovery. Guides agents through the full experiment lifecycle: understanding recipes and environments, wiring RL or NeMo-gym runs, launching reproducible baselines and iterations, analyzing results, preserving human oversight, and using git plus TSV logs as the research ledger.
Brev instance operating guidance for NeMo-RL agents working in /home/ubuntu/RL with limited workspace disk, a larger /ephemeral volume, and optional /home/ubuntu/RL/.env secrets. Use when running auto-research campaigns, experiments, training jobs, model or dataset downloads, shared cache-heavy commands, log-producing runs, checkpoint generation, W&B or Hugging Face authenticated workflows, or any workflow that may create large files on Brev.
Manage durable working-session memory for coding agents. Use when a user asks to preserve or recover agent context across disconnects, VS Code restarts, long-running work, handoffs, or any session where important state should be written periodically under the repo's session directory.
Configuration conventions for NeMo-RL. YAML is the single source of truth for defaults. Covers TypedDict usage, exemplar YAML updates, and forbidden default patterns.
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.