Skip to content

Comments

Add AGENTS.md#21537

Open
tay1orjones wants to merge 10 commits intocarbon-design-system:mainfrom
tay1orjones:add-agents-md
Open

Add AGENTS.md#21537
tay1orjones wants to merge 10 commits intocarbon-design-system:mainfrom
tay1orjones:add-agents-md

Conversation

@tay1orjones
Copy link
Member

@tay1orjones tay1orjones commented Feb 12, 2026

Closes #21520

Adds AGENTS.md to the repo. They're intentionally brief and only include breadcrumbs to further resources to avoid unnecessary instruction length. Read this. If you think we can shorten it further let me know.

A new build step generates files that provide context on our package structure. These should be easily/cheaply ingested by models compared to them having to "manually" discover it. It includes both directory structure and dependency graph structure. It's tied to the build so it's always up to date with local changes. I purposefully excluded them from git because they don't need to be tracked.

Changelog

New

  • Add AGENTS.md for root and 3 key packages
  • Add package structure file generation build script
  • Add additional CI step to flag changes to AGENTS.md via a PR comment
  • Add package structure document for human maintainers

Changed

  • codeowners, gitignore

Testing / Reviewing

PR Checklist

As the author of this PR, before marking ready for review, confirm you:

  • Reviewed every line of the diff
  • Updated documentation and storybook examples
    - [ ] Wrote passing tests that cover this change
    - [ ] Addressed any impact on accessibility (a11y)
    - [ ] Tested for cross-browser consistency
  • Validated that this code is ready for review and status checks should pass

More details can be found in the pull request guide

@netlify
Copy link

netlify bot commented Feb 12, 2026

Deploy Preview for v11-carbon-react ready!

Name Link
🔨 Latest commit dd75438
🔍 Latest deploy log https://app.netlify.com/projects/v11-carbon-react/deploys/6996fc219b0fc800080ce52c
😎 Deploy Preview https://deploy-preview-21537--v11-carbon-react.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link

netlify bot commented Feb 12, 2026

Deploy Preview for v11-carbon-web-components ready!

Name Link
🔨 Latest commit dd75438
🔍 Latest deploy log https://app.netlify.com/projects/v11-carbon-web-components/deploys/6996fc2129c1730008e3abd1
😎 Deploy Preview https://deploy-preview-21537--v11-carbon-web-components.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Member

@kennylam kennylam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Just a few typo fixes. I know the agents won't care, just being consistent.

Co-authored-by: kennylam <909118+kennylam@users.noreply.github.com>
Copy link
Member

@alisonjoseph alisonjoseph left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this, LGTM!

@kennylam kennylam enabled auto-merge February 13, 2026 16:02
Copy link
Contributor

@heloiselui heloiselui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is really nice! Thanks @tay1orjones 🚀

Copy link
Member

@emyarod emyarod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add AGENTS.md

7 participants