Skip to content

[doc, misc] chore: add Claude Code skills and CLAUDE.md for AI-assisted development#5843

Open
khazic wants to merge 1 commit intoverl-project:mainfrom
khazic:feat/claude-code-skills
Open

[doc, misc] chore: add Claude Code skills and CLAUDE.md for AI-assisted development#5843
khazic wants to merge 1 commit intoverl-project:mainfrom
khazic:feat/claude-code-skills

Conversation

@khazic
Copy link
Copy Markdown
Contributor

@khazic khazic commented Apr 1, 2026

What does this PR do?

Add project-specific Claude Code configuration to help AI assistants work more effectively within veRL's codebase. This includes a CLAUDE.md project overview and 11 guided development skills under .agents/skills/.

These files are only read by Claude Code and do not affect veRL runtime behavior.

Checklist Before Starting

  • Search for similar PRs: no existing Claude Code configuration found in veRL

Test

No runtime changes -- configuration files only, not imported by veRL.

Design & Code Changes

  • CLAUDE.md: project overview, directories, commands, PR workflow, skill index
  • .agents/skills/add-reward: compute_score and RewardManager guide
  • .agents/skills/add-dataset: dataset preprocessing (raw to parquet) guide
  • .agents/skills/add-trainer: Ray worker trainer/recipe guide
  • .agents/skills/add-unit-tests: CPU/GPU test conventions and CI registration
  • .agents/skills/debug-distributed: hangs, OOM, NaN, Ray crashes, HybridEngine
  • .agents/skills/commit-conventions: veRL module scopes and PR title format
  • .agents/skills/create-pr: upstream/main branching and title format enforcement
  • .agents/skills/review-pr: risk-based review (DataProto, HybridEngine as CRITICAL)
  • .agents/skills/upgrade-vllm: vLLM call site audit for rollout workers
  • .agents/skills/upgrade-sglang: SGLang io_struct, weight_sync, EngineBase audit
  • .agents/skills/upgrade-megatron-core: patch.py, MoE router replay, mbridge audit

Checklist Before Submitting

  • Read the Contribute Guide
  • pre-commit not applicable (markdown only)
  • No tests needed (configuration files only)

…lopment

Add project-specific Claude Code configuration to help AI assistants work
effectively within veRL's codebase structure and conventions.

Key changes:
- CLAUDE.md: project overview, core directories, constraints, PR workflow,
  and skill index for quick reference
- .agents/skills/add-reward: guide for adding compute_score reward functions
- .agents/skills/add-dataset: guide for dataset preprocessing (raw to parquet)
- .agents/skills/add-trainer: guide for new algorithm trainer/recipe
- .agents/skills/add-unit-tests: CPU/GPU test conventions and CI registration
- .agents/skills/debug-distributed: troubleshooting hangs, OOM, NaN, Ray errors
- .agents/skills/commit-conventions: Conventional Commits with veRL module scopes
- .agents/skills/create-pr: PR workflow branching from upstream/main
- .agents/skills/review-pr: risk-based PR review with veRL risk matrix
- .agents/skills/upgrade-vllm: vLLM upgrade audit for rollout workers
- .agents/skills/upgrade-sglang: SGLang upgrade audit for io_struct and weight_sync
- .agents/skills/upgrade-megatron-core: Megatron-Core upgrade audit
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a comprehensive set of documentation and 'skills' guides for the veRL project, along with a project overview file (CLAUDE.md). These additions provide detailed instructions and best practices for core development tasks, including adding datasets, reward functions, trainers, and unit tests. Furthermore, it includes specialized guides for debugging distributed training and managing upgrades for key dependencies like vLLM, SGLang, and Megatron-Core. The PR also formalizes project conventions for commit messages and pull request workflows. I have no feedback to provide as there were no review comments.

@tongyx361
Copy link
Copy Markdown
Collaborator

Could you split the skills into different PRs and provide some usage examples to show whether it works well for each skill?

@khazic
Copy link
Copy Markdown
Contributor Author

khazic commented Apr 1, 2026

Could you split the skills into different PRs and provide some usage examples to show whether it works well for each skill?

okay will do it

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