chore: Add AGENTS.md file#3145
Open
taylorvnoj wants to merge 2 commits into
Open
Conversation
Deploying atlantis with
|
| Latest commit: |
21f092e
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://c5a8e142.atlantis.pages.dev |
| Branch Preview URL: | https://job-165818-agents-file.atlantis.pages.dev |
nad182
reviewed
May 11, 2026
Comment on lines
+35
to
+36
| - Add a new spec file only for new components, major component refactors, or | ||
| when the work is explicitly establishing long-term component guidance. |
Contributor
There was a problem hiding this comment.
I think we could even be more "aggressive" and instruct the agents to assess it themselves whether the components it modifies would benefit from adding specs. It would still be up to us to accept or reject those. But this could speed up the process of adding those "organically" without additional cognitive load for us, devs.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Why Is This Changing?
AGENTS.mdgives AI coding agents the context and rules they need to work safely and consistently in our design system.This is helpful for:
The intention behind creating this now, is to help with adding
spec.mdfiles when doing component upgrades or, large refactors to components. This will also remind the agent to update docs with any regular component updates.We can also, in the future, have
AGENTS.mdfiles in each package for more fine tuned directions.What Is Changing?
Adding root level
AGENTS.mdConsumer Impact
Validation
https://agents.md/
Reviewer Notes
Changes can be
tested via Pre-release
In Atlantis we use Github's built in pull request reviews.