-
-
Notifications
You must be signed in to change notification settings - Fork 722
docs(AGENTS.md): Make AGENTS.md concise for AI assistants with setup notes - reduce token usage by 70% #12968
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(AGENTS.md): Make AGENTS.md concise for AI assistants with setup notes - reduce token usage by 70% #12968
Conversation
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. |
Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
|
@copilot keep the following:
Also change Rust MSRV to 1.87.0 |
Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
Added the requested setup notes and updated MSRV to 1.87.0. The AGENTS.md now includes:
Commit: 8660f09 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR streamlines the AGENTS.md file to optimize token usage for AI assistants by reducing verbosity and redundancy while adding essential setup guidance. The file is condensed from 349 lines to 109 lines (70% reduction) to improve efficiency for AI context windows.
Key Changes:
- Removed verbose examples section (130+ lines) and replaced with concise key examples
- Eliminated decorative formatting and redundant information
- Added critical setup notes about pre-installed tools to prevent installation errors
…notes - reduce token usage by 70% (oxc-project#12968)
This PR significantly reduces the size and complexity of
AGENTS.mdto make it more efficient for AI assistants like GitHub Copilot, Claude Code, and similar tools to process and understand, while adding important setup guidance.Problem
The original
AGENTS.mdfile was 349 lines long with extensive verbose explanations, detailed examples for every crate, and decorative formatting that consumed excessive tokens when processed by AI assistants. This led to:Solution
Streamlined the file to focus on essential, actionable information while removing unnecessary verbosity and adding critical setup notes:
Key Changes:
What's Preserved and Enhanced:
just ready,just fmt, etc.)cargo-insta,typos-cli,cargo-shear,dprint)just readyas final step after commitsclippy,rust-docs,rustfmt)Results
The concise version provides better guidance for AI assistants while being much more efficient to process, leading to improved performance, reduced costs, and fewer setup errors for AI-powered development tools.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.