-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Streamline AGENTS.md by removing redundant content #7879
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
Streamline AGENTS.md by removing redundant content #7879
Conversation
- Remove project structure, setup, build, and test instructions that duplicate content already in CONTRIBUTING.md - Add prominent "Required Workflow" section emphasizing that agents must run fmt, lint, and test on the entire repository before completing tasks - Reorganize "Do Not Edit" section to include submodules alongside auto-generated files - Reference CONTRIBUTING.md for detailed contribution guidelines 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: Yuri Shkuro <yuri_shkuro@Yuris-MacBook-Pro.local>
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 by removing redundant documentation that duplicates content already present in CONTRIBUTING.md, reducing the file from 51 to 31 lines. The changes emphasize critical workflow steps that AI agents commonly neglect and improve the organization of important warnings.
Changes:
- Removed duplicate project structure, setup, build, and test instructions
- Added prominent "Required Workflow" section emphasizing mandatory fmt, lint, and test steps
- Reorganized "Do Not Edit" section to separately list auto-generated files and submodules
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7879 +/- ##
==========================================
+ Coverage 95.49% 95.50% +0.01%
==========================================
Files 305 305
Lines 16212 16212
==========================================
+ Hits 15481 15483 +2
+ Misses 572 571 -1
+ Partials 159 158 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Metrics Comparison SummaryTotal changes across all snapshots: 0 Detailed changes per snapshotsummary_metrics_snapshot_cassandra📊 Metrics Diff SummaryTotal Changes: 0
summary_metrics_snapshot_cassandra📊 Metrics Diff SummaryTotal Changes: 0
summary_metrics_snapshot_cassandra📊 Metrics Diff SummaryTotal Changes: 0
|
jkowall
left a comment
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.
Looks good, it seems less explicit (just read contributing.md) but I guess it should do so hopefully.
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
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
## Summary - Remove project structure, setup, build, and test instructions that duplicate content already in CONTRIBUTING.md - Add prominent "Required Workflow" section emphasizing that agents must run fmt, lint, and test on the entire repository before completing tasks - Reorganize "Do Not Edit" section to include submodules alongside auto-generated files - Reference CONTRIBUTING.md for detailed contribution guidelines ## Changes - Reduced file from 51 lines to 30 lines - Removed redundant documentation present in CONTRIBUTING.md - Emphasized critical workflow steps that AI agents commonly neglect - Improved logical grouping of "Do Not Edit" warnings 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Signed-off-by: Yuri Shkuro <yuri_shkuro@Yuris-MacBook-Pro.local> Signed-off-by: Yuri Shkuro <github@ysh.us> Co-authored-by: Yuri Shkuro <yuri_shkuro@Yuris-MacBook-Pro.local> Co-authored-by: Claude <noreply@anthropic.com>
Summary
Changes
🤖 Generated with Claude Code