Skip to content

Add AGENTS.md #2878

@dingsdax

Description

@dingsdax

The repository-docs standard requires every SDK repo to have an AGENTS.md at the repository root. sentry-ruby currently has no AGENTS.md, meaning AI agents working in this repo have no architecture context, no testing conventions, no build instructions, and no SDK-specific standard overrides. The file that makes agentic contributions accurate and consistent.

What needs to be done

  1. Create AGENTS.md at the repo root. Use agents-md skill.
  2. Create CLAUDE.md as a symlink: ln -s AGENTS.md CLAUDE.md
  3. Fill in all SDK-specific sections:
    • Package manager and key commands (Bundler, Rake)
    • Architecture overview (monorepo structure: sentry-ruby, sentry-rails, sentry-sidekiq, sentry-resque, sentry-delayed_job, sentry-opentelemetry)
    • Development workflow (build, test, lint commands)
    • Testing conventions (RSpec, test file naming, what test types are required per change type)
    • Standards overrides (any known deviations from the SDK standards)
    • Create nested AGENTS.md if necessary
  4. Verify accuracy: have an AI tool attempt a small contribution using the file as context before merging

Metadata

Metadata

Assignees

Labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions