Skip to content

docs: add CLAUDE.md and AGENTS.md AI agent guidelines - #915

Merged
tanya732 merged 4 commits into
masterfrom
chore/add-claude-md-and-references
Aug 13, 2026
Merged

docs: add CLAUDE.md and AGENTS.md AI agent guidelines#915
tanya732 merged 4 commits into
masterfrom
chore/add-claude-md-and-references

Conversation

@tanya732

@tanya732 tanya732 commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Changes

Adds AI coding-agent guidance to the repo:

Files added/updated

  • CLAUDE.md - agent role, working principles, project overview, structure, boundaries (Always Do / Ask First / Never Do), security considerations, and lazy-loaded pointers into references/. The central theme is the Fern generated-vs-hand-maintained split: .fernignore is the source of truth for what's safe to edit, generated files carry the auto-generated header, and durable Management API fixes belong in the Fern spec/generators/java-v2 generator rather than in local edits.
    • AGENTS.md - imports CLAUDE.md (@./CLAUDE.md) so non-Claude tools pick up the same guidance.
    • references/ — detailed content offloaded from the root file: commands.md, testing.md, code-style.md, git-workflow.md, pitfalls.md, docs-update.md.
    • .fernignore — adds CLAUDE.md, AGENTS.md, and references/ so these hand-maintained docs are not overwritten on the next SDK regeneration (same treatment as README.md/EXAMPLES.md).

Note - No source code changes - docs/config only.

Testing

Docs-only change; no runtime behavior affected.

  • Verified that every repo path referenced in CLAUDE.md and references/*.md resolves on disk, and all CLAUDE.md → references/*.md cross-links exist.
  • Verified documented APIs against the source (AuthAPI.newBuilder(...), ManagementApi.builder().clientCredentials(...)).
  • Cross-checked documented commands against build.gradle and .github/workflows/build-and-test.yml.
  • Verified the generator path (generators/java-v2) and related documentation links against CONTRIBUTING.md.
  • N/A — No test coverage added; documentation-only change.

Checklist

@tanya732
tanya732 requested a review from a team as a code owner August 13, 2026 10:19
tanya732 and others added 2 commits August 13, 2026 16:06
Correct json/auth as hand-maintained (drop non-existent json/mgmt clause)
and point CONTRIBUTING.md links at the About Generated Code anchor.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@tanya732
tanya732 merged commit 0b08aff into master Aug 13, 2026
7 checks passed
@tanya732
tanya732 deleted the chore/add-claude-md-and-references branch August 13, 2026 11:29
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.

2 participants