Repository and Documentation
These standards define what every SDK repository should contain beyond the code itself — the files that help humans and AI tools understand, contribute to, and maintain the project.
Every SDK repo MUST have an AGENTS.md covering:
- Architecture overview
- Testing conventions
- Build instructions
- Contribution expectations
- Commit attribution convention
- SDK-specific standard overrides — updated in the same PR as architectural changes
Every SDK repo MUST have a CONTRIBUTING.md covering:
- Setup instructions
- Development workflow
- Explicit quality bar
- Discussion-first policy
- AI tools section
Every SDK repo MUST have a GitHub PR template with description structure guidance and a linked-issue reminder. Keep it minimal — provide guidance rather than enforcing rigid structure with mandatory sections.
User-facing changes need corresponding docs:
- New feature: docs PR to sentry-docs
- Behavior change: docs update
- Deprecation: migration guide (see breaking changes and deprecations)
- New config option: docs entry
The SDK PR should link to the docs PR. Neither merges without the other being at least approved.
AI context files — AGENTS.md, .cursorrules, .github/copilot-instructions.md, CLAUDE.md — are living documentation. Keep them up to date with architectural changes, review them quarterly, and periodically test them by having an AI tool attempt a contribution.
AGENTS.md is required. The others are recommended.
SDK repos SHOULD also have dotagents configured with skills from getsentry/skills and getsentry/sdk-skills. Commit agents.toml and agents.lock so every engineer on the team gets the same skills automatically. See the dotagents documentation for setup instructions.
Rules files (e.g., .claude/rules/, .cursor/rules/) SHOULD be used for fixed workflow conventions that apply to a specific task or directory.
| Version | Date | Summary |
|---|---|---|
1.1.0 | 2026-03-06 | Add AI Skills SHOULD requirement (dotagents + rules files) |
1.0.0 | 2026-02-19 | Initial Repository and Documentation standard |
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").