Repository navigation
Add ARCHITECTURE.md, CONTRIBUTING.md, and AI agent tooling setup - #3229
Merged
Merged
Conversation
Adds a vendor-neutral AGENTS.md (read natively by Codex, Cursor, and other tools) plus a Claude Code CLAUDE.md that imports it. Also commits the first Agent Skill, sentry-triage, which is portable across tools per the open Agent Skills spec. .gitignore is scoped so personal/local config (settings.json, settings.local.json, .mcp.json) stays untracked. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Adds ARCHITECTURE.md and CONTRIBUTING.md (compiled from a 2022 maintainer deep-dive, fact-checked and corrected against the current pom.xml/CI config: JDK version, module counts, the graphstore split, release pipeline behavior). CONTRIBUTING.md also gains command-line mvn instructions alongside the IDE workflow, an API-changelog convention section, a PR-template pointer, and release lessons mined from the 0.11.0-0.11.2 cycle. AGENTS.md is updated to reference both new docs and the PR title/checklist convention. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
3 tasks done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds contributor-facing documentation and vendor-neutral AI-agent tooling, none of which touches product code:
pom.xml/CI config (JDK version, module counts, thegraphstoresplit, release pipeline behavior). CONTRIBUTING.md also documents themvnCLI build/test commands (verified locally —mvn -T 4 --batch-mode -Djava.awt.headless=true verify -P enableCheckStylepasses, 76/76 modules), the API-changelog convention forsrc/main/javadoc/overview.html, the PR-template convention, and lessons mined from the 0.11.0–0.11.2 release cycle. Duplicated content between the two files was removed in favor of cross-references..claude/settings.json,.claude/settings.local.json,.mcp.json) stays untracked, while.claude/CLAUDE.mdand.claude/skills/are shared.Checklist
Added tests?
Added to documentation?
This PR is the documentation update (ARCHITECTURE.md/CONTRIBUTING.md/AGENTS.md); README.md and the API changelog didn't need changes for this.
🤖 Generated with Claude Code