Skip to content

docs: Added CLAUDE.md with AGENTS.md and references - #141

Open
rmad17 wants to merge 1 commit into
mainfrom
feat/claude-md
Open

rmad17 wants to merge 1 commit into
mainfrom
feat/claude-md

Conversation

@rmad17

@rmad17 rmad17 commented Oct 12, 2026

Copy link
Copy Markdown
Contributor

Changes

Adds agent-facing contributor guidance so AI coding assistants work within this SDK's security and compatibility rules. Docs and tooling config only, no library code changes.

Added

  • CLAUDE.md: role, working principles, project structure, Always / Ask First / Never boundaries, security considerations (algorithm pinning, no token-derived fetches, MCD resolver trust, DPoP checks, token exchange guards), and short anchors into the reference files
  • AGENTS.md: pointer to CLAUDE.md for agents that read AGENTS.md
  • references/commands.md: install, test, coverage and lint commands that match CI
  • references/testing.md: test layout, fixtures, async marker requirement, pytest-httpx mocking
  • references/code-style.md: naming, error class pattern, # noqa: S105 usage for constants
  • references/flow-map.md: entry points, helpers, tests and docs for each flow (Bearer/DPoP verification, connection tokens, custom token exchange, OBO, delegation, MCD, caching, anonymous callers)
  • references/git-workflow.md: branch naming, commit prefixes, PR template sections
  • references/pitfalls.md: Python 3.9 floor, ruff format not a CI gate, two dependency lists, custom_fetch scope, stale venvs
  • references/docs-update.md: tracked docs inventory and code-to-docs update map

No public API, ApiClientOptions, error code, or dependency changes.

@rmad17
rmad17 requested a review from a team as a code owner October 12, 2026 15:26

This branch has not been deployed

No deployments
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