Skip to content

docs: add CLAUDE.md agent guidelines for auth0-server-python#132

Open
sanchitmehtagit wants to merge 2 commits into
mainfrom
claude-md-guidelines
Open

docs: add CLAUDE.md agent guidelines for auth0-server-python#132
sanchitmehtagit wants to merge 2 commits into
mainfrom
claude-md-guidelines

Conversation

@sanchitmehtagit

Copy link
Copy Markdown

Summary

Adds AI-agent guidelines for auth0-server-python — a lean, guardrail-first CLAUDE.md plus a thin AGENTS.md that points to it, generated by the generating-claude-md skill and validated against the repo.

  • CLAUDE.md (127 lines) — persona, working principles, project overview/structure, three-tier Boundaries, Security, and one-line anchors into references/.
  • AGENTS.md — references @CLAUDE.md so non-Claude tools (Codex CLI, Gemini CLI) share the same guidance.
  • references/*.md — full detail offloaded on demand: commands, testing, code-style, git-workflow, pitfalls, docs-update.

What detection surfaced (auth0-server-python specific)

  • Async Python auth library (Poetry, ruff, pytest+asyncio, Pydantic v2) — persona reflects async-first, type-annotated code that keeps ServerClient stable across Python 3.9–3.12.
  • Auth0-Client telemetry header (telemetry.py) → documented in Security (shared per-request infra, not a per-feature boundary).
  • No live-tenant test tier — everything is mocked with AsyncMock, so the default suite is unit-only and there's no Ask-First test rule or integration section.
  • Security posture — JWT/JWKS verification, PKCE, and encrypted state store (encryption/, secret+salt) → in Security, not the persona.
  • Code-to-docs mapping (library shape) — each ServerClient capability mapped to its hand-written examples/*.md guide; no generated API-doc site.
  • ruff with bandit (S) enabled → CI-enforced style guardrail + a pitfall.

Validation

Filesystem validation pass: every cited path (16/16), every examples/*.md (9/9), and every references/*.md pointer (6/6) verified to exist in the repo — no invented tooling.

Generated by the generating-claude-md skill.

sanchitmehtagit and others added 2 commits July 15, 2026 11:04
Removes the instruction to auto-update CHANGELOG.md from the Always-Do
boundary, the git-workflow flow, and the docs-update tracked-docs and
code-to-docs mapping. Mirrors the generating-claude-md skill change:
changelog/release maintenance is not an agent file-editing task.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@sanchitmehtagit
sanchitmehtagit marked this pull request as ready for review July 15, 2026 09:27
@sanchitmehtagit
sanchitmehtagit requested a review from a team as a code owner July 15, 2026 09:27
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.

1 participant