Skip to content

docs: drop stale crate paths from AGENTS.md - #8425

Merged
youknowone merged 1 commit into
RustPython:mainfrom
leehanjeong:8416-agents-md-crates-layout
Aug 1, 2026
Merged

docs: drop stale crate paths from AGENTS.md#8425
youknowone merged 1 commit into
RustPython:mainfrom
leehanjeong:8416-agents-md-crates-layout

Conversation

@leehanjeong

@leehanjeong leehanjeong commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

Summary

AGENTS.md's "Repository Structure" section described the pre-crates/ layout (vm/, compiler/, derive/, etc.), none of which exist anymore. CONTRIBUTING.md already documents the current layout under "Code organization", so this replaces the stale list with a link there instead of maintaining two copies that can drift apart again.

Also generalized the file's title/intro from "GitHub Copilot Instructions" to "AI Agent Instructions". The file was already renamed from .github/copilot-instructions.md to AGENTS.md in #6813 to follow the cross-vendor AGENTS.md standard, but the title text was never updated to match. Happy to revert this part if the intent was Copilot-specific.

Assisted-by: Claude Code:claude-sonnet-5

Summary by CodeRabbit

  • Documentation
    • Updated contributor guidance to support a broader range of AI coding agents.
    • Replaced outdated repository structure details with a link to the current code organization documentation.

The "Repository Structure" section listed pre-`crates/` paths (`vm/`,
`compiler/`, `derive/`, etc.) that no longer exist; `CONTRIBUTING.md`
already documents the current layout under "Code organization". Replace
the stale list with a link to that section.

Also generalized the title and intro from "GitHub Copilot Instructions"
to "AI Agent Instructions" — the file was already renamed from
`.github/copilot-instructions.md` to `AGENTS.md` in RustPython#6813 to follow the
cross-vendor AGENTS.md standard (https://agents.md/), but the title text
was never updated to match.

Assisted-by: Claude Code:claude-sonnet-5
@coderabbitai

coderabbitai Bot commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

AGENTS.md now provides guidance for AI coding agents generally. It links to the current repository code organization in CONTRIBUTING.md instead of maintaining a static directory listing.

Changes

AI agent guidance

Layer / File(s) Summary
Update agent guidance
AGENTS.md
The document targets AI coding agents instead of GitHub Copilot specifically. The outdated repository structure listing is replaced with a link to CONTRIBUTING.md.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

Suggested labels: skip:ci

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The changes replace the obsolete repository structure with a CONTRIBUTING.md link and generalize the Copilot-specific document title as required by issue #8416.
Out of Scope Changes check ✅ Passed The changes are limited to AGENTS.md documentation updates and align with the linked issue objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the main documentation change: removing obsolete crate paths from AGENTS.md.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@moreal moreal added the z-ca-2026 Tag to track Contribution Academy 2026 label Aug 1, 2026

@youknowone youknowone left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👍 Thank you!

@youknowone
youknowone merged commit bd653da into RustPython:main Aug 1, 2026
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

z-ca-2026 Tag to track Contribution Academy 2026

Projects

None yet

Development

Successfully merging this pull request may close these issues.

AGENTS.md: Repository Structure section predates the move into crates/

3 participants