docs: Add AGENTS.md to allow LLMs to work effectively with the codebase #4481
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
LLM agent tools are very popular for developers and auditors alike. Providing an
AGENTS.md
file should allow them to be more effective with their tools. We may as well add one here because people using these tools will be creating their own versions of it anyway.I used the nomenclature from https://agents.md because it seems to be the most general/least vendor-specific, but I'm open to using a different style or name.
It's important to keep these files pretty concise in order to not waste context window space or otherwise 'poison' the window with irrelevant or misleading info. As a result, I tried to avoid content that's already well-covered by README, CONTRIBUTING, and DEVELOP or items that are already handled by CI.