Skip to content

[Rust Frontend] Refresh rust/AGENTS.md with ownership and design conventions - #62721

Merged
BugenZhao merged 2 commits into
vllm-project:mainfrom
BugenZhao:bz/rust-agents-md
Oct 21, 2026
Merged

BugenZhao merged 2 commits into
vllm-project:mainfrom
BugenZhao:bz/rust-agents-md

Conversation

@BugenZhao

@BugenZhao BugenZhao commented Oct 20, 2026 •

Copy link
Copy Markdown
Member

Overview

Refresh rust/AGENTS.md, which has not changed since the Rust frontend moved into this repo (#43283), and link it from the root AGENTS.md domain-specific guides.

Claims

  • Replace stale guidance: "fine to break API" becomes a compatibility rule scoped to real wire consumers, and "prefer splitting into smaller files" becomes splitting by ownership.
  • Add the conventions Rust frontend reviews keep applying: a crate ownership table, design principles (strong types, ownership of fields and checks, lifecycle, rejecting unimplemented behavior), Python frontend parity, parser rules, and which evidence supports which claim.
  • Ask PR descriptions to list intentional deviations from the guide or from Python frontend behavior, instead of a generic "followed the guide" statement.
  • Keep the existing winnow, thiserror-ext, expect-test, for_test(), nextest, and Unix-only rules as written.

Validation

  • pre-commit passes on the commit, including check-agent-files (root 158/200 lines, rust/AGENTS.md 116/300) and markdownlint-cli2.
  • Two independent agent reviews checked every concrete claim against the code under rust/. The draft was corrected where it disagreed with intentional code: Noop CLI flags, one tool parser type registered under several names, token-identity markers only where the parser receives decoded tokens, and the scripted in-process mock engine versus the random-token vllm-mock-engine binary.

Details

  • Duplicate check: no open PR touches rust/AGENTS.md.
  • Generic testing, diff, and benchmark advice already covered by the root AGENTS.md and the pr-checklist skill is left out.
  • The root link means agents starting from the repo root read the Rust guide before editing rust/.
  • Not done: the editing guide's "Tested?" step, running an agent against each new rule.

Pull Request Checklist
  • I used vLLM's /pr-checklist skill. (Mandatory for agents, optional for humans).

  • AI assistance was used during the creation of this PR.

  • Design Fit: Minimizes impact on core components, reuses existing functionality, and justifies added complexity.

  • Testing and Validation: Validates the change and ensures any added tests are meaningful and reliable, with CI coverage or documented CI resource constraints and validation performed outside CI.

  • Code Quality and Style: Keeps code and comments clear and concise, and updates relevant documentation and examples.

  • Pull Request Contents: Includes a brief summary and relevant links, supports claims with evidence, explains root causes and implementation trade-offs, and follows the contributing guide.

🤖 Generated with Claude Code

…entions

Replace stale guidance ("fine to break API", unconditional file splitting)
and add the conventions reviewers keep applying to Rust frontend PRs: crate
ownership, design principles, Python frontend parity, parser rules,
validation by claim, and a PR note for intentional deviations. Link the
guide from the root AGENTS.md domain-specific guides.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Bugen Zhao <i@bugenzhao.com>
@BugenZhao
BugenZhao requested a review from njhill as a code owner October 20, 2026 15:43

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Claude Code Review

This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.

@mergify mergify Bot added rust agents Related to information for agents labels Oct 20, 2026
@BugenZhao
BugenZhao requested review from Isotr0py and esmeetu October 21, 2026 06:45
@BugenZhao

Copy link
Copy Markdown
Member Author

/ci run

@github-actions

Copy link
Copy Markdown

✅ Triggered Buildkite CI #96371 for commit f2cb535cf802.

ℹ️ This PR is 50 commits behind upstream main. Merged upstream main into this branch as f2cb535cf802 before starting CI. Pull the branch before pushing more changes.

@BugenZhao
BugenZhao merged commit e9cc624 into vllm-project:main Oct 21, 2026
10 checks passed
bantianyue pushed a commit to bantianyue/vllm that referenced this pull request Oct 28, 2026
…entions (vllm-project#62721)

Signed-off-by: Bugen Zhao <i@bugenzhao.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: vllm-agent <claw@inferact.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

agents Related to information for agents rust

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants