Skip to content

docs: add AGENTS.md and CLAUDE.md symlink #2900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
solnic merged 1 commit into from
Mar 18, 2026
+52 −0
Merged

docs: add AGENTS.md and CLAUDE.md symlink #2900

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Agent Instructions

## Package Manager
Use **Bundler**. Each gem has its own `Gemfile`; run commands from within the gem subdirectory.
```bash
cd sentry-ruby && bundle install
```

## Monorepo Structure
| Gem | Path | Description |
|-----|------|-------------|
| `sentry-ruby` | `sentry-ruby/` | Core SDK — all other gems depend on this |
| `sentry-rails` | `sentry-rails/` | Rails integration |
| `sentry-sidekiq` | `sentry-sidekiq/` | Sidekiq integration |
| `sentry-resque` | `sentry-resque/` | Resque integration |
| `sentry-delayed_job` | `sentry-delayed_job/` | DelayedJob integration |
| `sentry-opentelemetry` | `sentry-opentelemetry/` | OpenTelemetry integration |

Shared test infrastructure lives in `lib/sentry/test/`. Root `Gemfile.dev` defines shared dev dependencies.

## File-Scoped Commands
Run from within the target gem directory (e.g. `cd sentry-ruby`):

| Task | Command |
|------|---------|
| Install deps | `bundle install` |
| Run all tests | `bundle exec rake` |
| Run single spec | `bundle exec rspec spec/sentry/client_spec.rb` |
| Lint | `bundle exec rubocop path/to/file.rb` |
| Lint (autofix) | `bundle exec rubocop -a path/to/file.rb` |

Root-level `bundle exec rubocop` lints the entire repo. Root-level `bundle exec rake` runs the E2E/integration spec suite (not individual gem tests).

## Testing Conventions
- Framework: **RSpec**
- Spec files mirror source: `lib/sentry/client.rb` → `spec/sentry/client_spec.rb`
- Isolated specs go in `spec/isolated/` (loaded in separate processes)
- `sentry-rails` has `spec/versioned/` for Ruby-version-specific specs
- Environment variables control version matrices: `RAILS_VERSION`, `SIDEKIQ_VERSION`, `RACK_VERSION`, `REDIS_RB_VERSION`
- Every behavioral change needs a spec. Bug fixes need a regression test.

## Commit Attribution
AI commits MUST include:
```
Co-Authored-By: <agent-name> <noreply@example.com>
```

## Standards Overrides
- Changelog: DO NOT update `CHANGELOG.md` as it is automatically generated during the release process
- Linting: RuboCop with `rubocop-rails-omakase` base — see `.rubocop.yml`
- See `CONTRIBUTING.md` for release process and contribution workflow
1 change: 1 addition & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
AGENTS.md
Loading