-
Notifications
You must be signed in to change notification settings - Fork 6
Improve AGENTS.md #860
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
Improve AGENTS.md #860
Conversation
…, communication style, code quality and task management
|
📊 Type Coverage ReportCoverage Comparison
Files with Most Type Issues (Top 15)
This report was generated by the Type Coverage GitHub Action |
marcins
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.
Nice one! Left some comments.
Is there any issue with this file being so large in terms of "wasting" context or is that okay?
|
|
||
| CI configuration: `.github/workflows/ci.yml` | ||
|
|
||
| ### Git Workflow |
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.
Can we make sure to always ask before creating a commit or pull request (I prefer to do these myself, for example).
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.
Yep that is already included below
All modern LLMs support 200k+ tokens, this document is currently only around 4k, and so combined with modern tooling of thread compression etc I think it should be fine. I do want to make another pass at clearing out unnecessary detail, redundancies etc to get it a bit lower though, ideally 2k I think. |
|
I've just pushed fixes for the points raised in review as well a big refinement that brings the file down to around 3k tokens without sacrificing anything relevant to most agent work. |
Motivation
The current
AGENTS.mdfile is very minimal and thus LLMs (Codelassian, Rovo Dev, etc) often need to be explicitly given more contextual information and/or spend more time/tokens finding it themselves to provide more useful results.Changes
Expand AGENTS.md with more project information and guidelines on repository usage, file operations, communication style, code quality and task management.
Checklist
docs/folder[no-changeset]: This is effectively just a documentation change