Skip to content

docs: add AGENTS.md and agent reference docs - #176

Merged
rmad17 merged 5 commits into
mainfrom
docs/claude-md
Nov 17, 2026
Merged

rmad17 merged 5 commits into
mainfrom
docs/claude-md

Conversation

@rmad17

@rmad17 rmad17 commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Changes

Adds shared instructions for AI coding agents working in this repo, so tools that read AGENTS.md follow the same rules. Docs only. Nothing under src/ changes, and no endpoints, classes, or methods are added, deleted, deprecated, or changed.

  • AGENTS.md: the single instructions file. It has a project map, Always Do / Ask First / Never Do boundaries, a security section describing cookie, redirect, proxy-header, and backchannel-logout behavior, and short summaries that link to the reference docs.
  • references/, read only when a task needs them:
    • commands.md: install, lint, test, and build commands that match CI.
    • testing.md: test layout, fixtures, and mocking patterns.
    • code-style.md: ruff rules, naming, and a good and bad AuthClient wrapper example.
    • git-workflow.md: branch, commit, and PR conventions.
    • pitfalls.md: gotchas such as the missing top-level import, where the session cookie name is set, and unmarked async tests being skipped.
    • docs-update.md: which doc to update for each kind of code change.

Testing

Docs only, so there is no runtime behavior to test and no tests were added.
poetry run ruff check . passes.

  • This change adds unit test coverage. Not applicable as this is a docs change.
  • This change adds integration test coverage. Not applicable as this is a docs change.
  • This change has been tested on the latest version of the platform/language or why not. Not applicable as this is a docs change.

Checklist

Co-Authored-By: Claude <noreply@anthropic.com>
@rmad17
rmad17 requested a review from a team as a code owner October 29, 2026 05:30
@rmad17 rmad17 changed the title docs: add CLAUDE.md, AGENTS.md and agent reference docs docs: add AGENTS.md and agent reference docs Nov 17, 2026
@rmad17
rmad17 merged commit 973a8f4 into main Nov 17, 2026
9 checks passed
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