For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • About NVIDIA NeMo Relay
    • Overview
    • Architecture
    • Ecosystem
    • Concepts
    • Release Notes
  • Getting Started
    • Agent Runtime Primer
    • Prerequisites
    • Installation
    • Configuration / Setup
    • Quick Start
  • NVIDIA NeMo Relay CLI
    • About
    • Basic Usage
    • Claude Code
    • Codex
    • Cursor
    • Hermes Agent
  • Supported Integrations
    • About
    • OpenClaw Plugin Guide
    • LangChain Integration Guide
    • LangGraph Integration Guide
    • Deep Agents Integration Guide
  • Instrument Applications
    • About
    • Adding Scopes and Marks
    • Instrument a Tool Call
    • Instrument an LLM Call
    • Add Middleware
    • Code Examples
  • Observability Plugin
    • About
    • Configuration
    • Agent Trajectory Interchange Format (ATIF)
    • Agent Trajectory Observability Format (ATOF)
    • OpenTelemetry
    • OpenInference
  • Adaptive Plugin
    • About
    • Configuration
    • Adaptive Cache Governor (ACG)
    • Adaptive Hints
  • NeMo Guardrails Plugin
    • About
    • Configuration
  • Integrate into Frameworks
    • About
    • Adding Scopes
    • Wrap Tool Calls
    • Wrap LLM Calls
    • Handle Non-Serializable Data
    • Using Codecs
    • Provider Codecs
    • Provider Response Codecs
    • Code Examples
  • Build Plugins
    • About
    • Define a Plugin
    • Validate Plugin Configuration
    • Plugin Configuration Files
    • Register Plugin Behavior
    • Design Plugin Configuration
    • NeMo Guardrails Example Plugin
    • Code Examples
  • Contribute
    • About
    • Development Setup
    • Workflow and Reviews
    • Testing and Documentation
  • Reference
    • APIs
    • Performance
  • Resources
    • Support and FAQs
    • Glossary
    • Troubleshooting Guide
    • Community
    • Legal
NVIDIANVIDIA
Developer-friendly docs for your API
Privacy Policy | Your Privacy Choices | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2026, NVIDIA Corporation.

LogoLogo
On this page
  • Pre-Commit Hooks
  • Pull Request Process
  • Release Tags
  • PR Description
  • Review Expectations
  • DCO Sign-Off
  • Commit Messages
  • Sonar Suppressions
Contribute

Workflow and Reviews

||View as Markdown|
Previous

Development Setup

Next

Testing and Documentation

This page describes the contribution workflow from local hooks through PR review.

Pre-Commit Hooks

Install hooks after cloning:

$uv run pre-commit install

Run them manually across the repo with:

$uv run pre-commit run --all-files

The configured hooks include a lightweight Markdown link check for README.md, CONTRIBUTING.md, and files under fern/.

Pull Request Process

Before submitting a PR:

  1. Ensure relevant hooks and tests pass.
  2. Verify the workspace builds cleanly.
  3. Update docs for public changes.
  4. Rebase on the latest main.

Release Tags

Versioned release tags must be created as raw SemVer tags without a leading v.

  • Use 0.1.0 for stable releases.
  • Use 0.1.0-rc.1 for prereleases.
  • Do not create tags such as v0.1.0 or v0.1.0-rc.1.

This keeps tags aligned with Cargo versions across the workspace. CI still rejects v-prefixed release tags.

For the maintainer release process and release-notes policy, see RELEASING.md.

PR Description

Include:

  • What changed
  • Why it changed
  • How it was implemented
  • What testing was run
  • Any breaking changes

Review Expectations

These expectations describe how review is handled before changes are merged.

  • At least one approving review is required.
  • CI must pass before merge
  • Reviewers may request changes for code quality, docs, tests, or architecture.
  • Do not force-push during active review.

DCO Sign-Off

Every commit in a PR must include a DCO sign-off. Use:

$git commit -s

Commit Messages

Use the format:

type: short description

Common types:

  • feat
  • fix
  • docs
  • test
  • refactor
  • chore
  • perf

Sonar Suppressions

Use SONAR_IGNORE_START and SONAR_IGNORE_END only for narrow, documented false positives. Keep the suppressed region small and call it out explicitly in the PR description for reviewer sign-off.