Skip to content

docs: add CLAUDE.md and AGENTS.md for AI agent development guidance#1103

Merged
cv merged 1 commit intoNVIDIA:mainfrom
jyaunches:docs/add-claude-agent-md
Mar 30, 2026
Merged

docs: add CLAUDE.md and AGENTS.md for AI agent development guidance#1103
cv merged 1 commit intoNVIDIA:mainfrom
jyaunches:docs/add-claude-agent-md

Conversation

@jyaunches
Copy link
Copy Markdown
Contributor

@jyaunches jyaunches commented Mar 30, 2026

Summary

Add project-level configuration files (CLAUDE.md and AGENTS.md) that help AI coding agents understand the NemoClaw project structure, conventions, and development workflow.

Related Issue

N/A — new documentation for AI agent tooling support.

Changes

  • CLAUDE.md: Project overview, architecture map, development commands, code style conventions (commit messages, SPDX headers, JS/TS/shell patterns), test structure, git hooks, documentation workflow, and PR requirements.
  • AGENTS.md: Agent-specific quick reference, key architecture decisions (dual-language stack, testing strategy, security model), common patterns for making changes (CLI commands, plugin features, policy presets, docs), and gotchas.

Type of Change

  • Doc only. Prose changes without code sample modifications.

Testing

  • npx prek run --all-files passes (or equivalently make check).
  • All pre-push hooks pass (TypeScript type checks, Vitest, markdownlint).

Checklist

General

Doc Changes

  • Follows the style guide.
  • Cross-references and links verified.

Summary by CodeRabbit

  • Documentation
    • Added project guidance documentation covering architecture overview, development command instructions, and code conventions.
    • Includes quick-reference shortcuts for installing dependencies, running tests, and building components.
    • Documents testing organization, security considerations, contributor workflow patterns, and repository best practices.

Add project-level configuration files for AI coding agents:

- CLAUDE.md: Project overview, architecture map, development commands,
  code style conventions, test structure, and PR requirements.
- AGENTS.md: Agent-specific guidance including quick reference commands,
  key architecture decisions, common patterns for making changes,
  and gotchas for working with the dual-language stack.

These files help AI agents (Claude, Cursor, Codex, etc.) understand
the project structure, conventions, and development workflow without
needing to discover them from scratch each session.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 30, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 6aa8aecc-ffdc-4b44-8246-479e2ef28714

📥 Commits

Reviewing files that changed from the base of the PR and between 4487598 and 6b2939f.

📒 Files selected for processing (2)
  • AGENTS.md
  • CLAUDE.md

📝 Walkthrough

Walkthrough

Two new documentation files are added to the repository: AGENTS.md provides agent-specific project guidance including command shortcuts, architectural decisions, testing organization, and contributor workflows; CLAUDE.md provides project overview, architecture map, development commands, coding conventions, and PR requirements.

Changes

Cohort / File(s) Summary
Documentation
AGENTS.md, CLAUDE.md
New documentation files added. AGENTS.md contains agent execution context, development commands, architectural decisions, testing organization, security model, and contributor workflow patterns. CLAUDE.md contains project overview, architecture map, development commands, coding conventions, Git hooks, and PR submission requirements.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 Documentation bounces forth, clear and bright,
Agents and developers now set right,
AGENTS and CLAUDE guide the way,
Two documents to light the developer's day!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title 'docs: add CLAUDE.md and AGENTS.md for AI agent development guidance' directly and clearly describes the main change: adding two new documentation files. It is concise, specific, and accurately summarizes the primary objective of the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@cv cv merged commit dae494f into NVIDIA:main Mar 30, 2026
9 checks passed
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.

2 participants