Skip to content

docs: Migrate AGENTS.md to nested structure with agents.toml#5758

Merged
antonis merged 1 commit intomainfrom
antonis/migrate-agents-md
Mar 5, 2026
Merged

docs: Migrate AGENTS.md to nested structure with agents.toml#5758
antonis merged 1 commit intomainfrom
antonis/migrate-agents-md

Conversation

@antonis
Copy link
Contributor

@antonis antonis commented Mar 4, 2026

📢 Type of change

  • Bugfix
  • New feature
  • Enhancement
  • Refactoring

📜 Description

  • Split the monolithic AGENTS.md into directory-scoped nested files following the agents.md standard (as established in sentry-javascript)
  • Root AGENTS.md becomes a lightweight index (~100 lines) with quick-reference tables and pointers to nested files
  • Added agents.toml config and .agents/skills/ directory placeholder

New files

File Scope
packages/core/AGENTS.md TS/JS code style, testing, patterns
packages/core/android/AGENTS.md Java/Kotlin conventions, bridge pattern
packages/core/ios/AGENTS.md ObjC/Swift conventions, bridge pattern
samples/react-native/AGENTS.md Running & troubleshooting the RN sample
samples/expo/AGENTS.md Running the Expo sample
agents.toml agents.md standard config
.agents/skills/.gitkeep Empty skills directory (for follow-up PRs)

Notes

  • CLAUDE.md symlink still resolves (points to root AGENTS.md)
  • All content from the original file exists in exactly one place across the new files
  • Each nested file is self-contained for its directory scope

💡 Motivation and Context

Fixes #5745

💚 How did you test it?

  • CLAUDE.md symlink resolves correctly
  • Review each nested file for completeness and accuracy
  • Verify agents.toml is valid TOML

📝 Checklist

  • I added tests to verify changes
  • No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled
  • I updated the docs if needed.
  • I updated the wizard if needed.
  • All tests passing
  • No breaking changes

🔮 Next steps

#skip-changelog

🤖 Generated with Claude Code

Split the monolithic AGENTS.md into directory-scoped files following the
agents.md standard (as in sentry-javascript). The root file becomes a
lightweight index with pointers to nested files.

New files:
- packages/core/AGENTS.md — TS/JS code style, testing, patterns
- packages/core/android/AGENTS.md — Java/Kotlin conventions
- packages/core/ios/AGENTS.md — ObjC/Swift conventions
- samples/react-native/AGENTS.md — sample app usage
- samples/expo/AGENTS.md — Expo sample usage
- agents.toml — agents.md standard config
- .agents/skills/.gitkeep — skills directory placeholder

Refs #5745

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Contributor

github-actions bot commented Mar 4, 2026

Semver Impact of This PR

None (no version bump detected)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).


This PR will not appear in the changelog.


🤖 This preview updates automatically when you update the PR.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 4, 2026

Fails
🚫 Pull request is not ready for merge, please add the "ready-to-merge" label to the pull request

Generated by 🚫 dangerJS against e7fe85b

@antonis antonis marked this pull request as ready for review March 4, 2026 13:54
Copy link
Collaborator

@lucas-zimerman lucas-zimerman left a comment

Choose a reason for hiding this comment

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

LGTM!

@antonis antonis merged commit 29950e3 into main Mar 5, 2026
43 of 48 checks passed
@antonis antonis deleted the antonis/migrate-agents-md branch March 5, 2026 11:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Migrate agent instructions to dotagents with nested AGENTS.md files

2 participants