Add AGENTS.md
#2185
Merged
Add AGENTS.md
#2185
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
An AGENTS.md file is essentially a README for LLM agents that are being used to augment a developer's process. This file should, in theory, be kept up to date by the agents as patterns shift and change. You can see more about the reasoning for this file in the agents.md website[1] 1. https://agents.md/
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2185 +/- ##
=======================================
Coverage 93.21% 93.21%
=======================================
Files 324 324
Lines 3772 3772
Branches 557 539 -18
=======================================
Hits 3516 3516
Misses 256 256 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
hminsky2002
approved these changes
Jan 6, 2026
Contributor
hminsky2002
left a comment
hminsky2002
left a comment
There was a problem hiding this comment.
This is great, i'll try and make something similar for the front-end!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds an
AGENTS.mdto the repository, which can be passed by a developer to an LLM agent to provide basic context for the project and improve the quality of agent contributions. It's basically a README but meant for robots rather than humans.I don't know 100% what makes a "good" AGENTS.md file (this was generated by telling Claude Code to populate the file with whatever information it deemed relevant for an LLM agent). I also instructed it to include information about (1) dev lifecycles such as linting and formatting, and (2) keeping itself up to date in a developer agnostic way.