Skip to content

Commit bd653da

Browse files
authored
docs: drop stale crate paths from AGENTS.md (RustPython#8425)
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
1 parent dc1cae4 commit bd653da

1 file changed

Lines changed: 3 additions & 18 deletions

File tree

AGENTS.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# GitHub Copilot Instructions for RustPython
1+
# AI Agent Instructions for RustPython
22

3-
This document provides guidelines for working with GitHub Copilot when contributing to the RustPython project.
3+
This document provides guidelines for AI coding agents (GitHub Copilot, Claude Code, Gemini, etc.) contributing to the RustPython project.
44

55
## Project Overview
66

@@ -13,22 +13,7 @@ RustPython is a Python 3 interpreter written in Rust, implementing Python 3.14.0
1313

1414
## Repository Structure
1515

16-
- `src/` - Top-level code for the RustPython binary
17-
- `vm/` - The Python virtual machine implementation
18-
- `builtins/` - Python built-in types and functions
19-
- `stdlib/` - Essential standard library modules implemented in Rust, required to run the Python core
20-
- `compiler/` - Python compiler components
21-
- `parser/` - Parser for converting Python source to AST
22-
- `core/` - Bytecode representation in Rust structures
23-
- `codegen/` - AST to bytecode compiler
24-
- `Lib/` - CPython's standard library in Python (copied from CPython). **IMPORTANT**: Do not edit this directory directly; The only allowed operation is copying files from CPython.
25-
- `derive/` - Rust macros for RustPython
26-
- `common/` - Common utilities
27-
- `extra_tests/` - Integration tests and snippets
28-
- `stdlib/` - Non-essential Python standard library modules implemented in Rust (useful but not required for core functionality)
29-
- `wasm/` - WebAssembly support
30-
- `jit/` - Experimental JIT compiler implementation
31-
- `pylib/` - Python standard library packaging (do not modify this directory directly - its contents are generated automatically)
16+
See the "Code organization" section in [CONTRIBUTING.md](CONTRIBUTING.md#code-organization) for the current directory layout.
3217

3318
## AI Agent Rules
3419

0 commit comments

Comments
 (0)