Skip to content

docs: Add AGENTS.md with CLAUDE.md symlink#1279

Open
runningcode wants to merge 4 commits into
mainfrom
no/add-agents-md
Open

docs: Add AGENTS.md with CLAUDE.md symlink#1279
runningcode wants to merge 4 commits into
mainfrom
no/add-agents-md

Conversation

@runningcode

Copy link
Copy Markdown
Contributor

Adds agent and contributor guidance to the repo. There was no AGENTS.md, CLAUDE.md, or equivalent before — the useful knowledge was scattered across CONTRIBUTING.md, the Makefile, build.gradle.kts, and dangerfile.js.

The new AGENTS.md concentrates the things that aren't obvious from a glance at the tree:

  • This is a composite Gradle build — plugin source lives in plugin-build/src, with sentry-kotlin-compiler-plugin and sentry-snapshots-runtime pulled in via includeBuild.
  • Common commands: make format (spotless), make preMerge, integrationTest, plugin unit tests.
  • The SENTRY_AUTH_TOKEN requirement for upload tests and the local cli.executable override.
  • PR conventions, including the Danger-enforced changelog rule and conventional-commit scopes.

CLAUDE.md is a symlink to AGENTS.md so Claude Code and other tools read one source of truth with no drift.

#skip-changelog

🤖 Generated with Claude Code

Add agent and contributor guidance covering the composite Gradle build
layout, common commands, local sentry-cli override, debugging, and PR
conventions. Symlink CLAUDE.md to AGENTS.md so Claude Code and other
tools read a single source of truth.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The changelog entry must reference the PR number; add the gh command
to look it up, mirroring the sentry-java AGENTS.md.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

@0xadam-brown 0xadam-brown left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Off to the races!

Comment thread AGENTS.md Outdated
runningcode and others added 2 commits June 8, 2026 17:30
Co-authored-by: Markus Hintersteiner <markus.hintersteiner@sentry.io>
A release cut on main can rename the Unreleased heading to a version,
leaving a rebased PR's entry under a released section. Document moving
it back to the top.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.

3 participants