Skip to content

docs: Add AGENTS.md and CLAUDE.md for AI agent contribution guidance - #158

Open
Dev-iL wants to merge 1 commit into
crystaldba:mainfrom
Dev-iL:add-agentic-files
Open

Dev-iL wants to merge 1 commit into
crystaldba:mainfrom
Dev-iL:add-agentic-files

Conversation

@Dev-iL

@Dev-iL Dev-iL commented Mar 19, 2026

Copy link
Copy Markdown

AGENTS.md provides universal rules for all AI agents: safety guardrails (get_sql_driver() hard rule), CI commands, project structure, and code conventions. CLAUDE.md adds Claude-specific tool preferences, MCP-aware validation workflows, and commit style guidance — referencing AGENTS.md for shared rules rather than duplicating them.

AGENTS.md provides universal rules for all AI agents: safety guardrails
(get_sql_driver() hard rule), CI commands, project structure, and code
conventions. CLAUDE.md adds Claude-specific tool preferences, MCP-aware
validation workflows, and commit style guidance — referencing AGENTS.md
for shared rules rather than duplicating them.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@Dev-iL

Dev-iL commented Apr 29, 2026

Copy link
Copy Markdown
Author

@jssmith can you please take a look?

@jssmith jssmith left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review — concise

Verdict: Approve. Clear, well-organized developer documentation.

Strengths

  • AGENTS.md covers the critical safety rule (get_sql_driver()), CI commands, project structure, and code conventions. Concise and actionable.
  • CLAUDE.md complements without duplicating — covers Claude-specific tool preferences, MCP-aware dev workflow, and commit style.
  • Cross-references between the two files are correct and helpful.

Minor (non-blocking)

  • CLAUDE.md references AGENTS.md for shared rules — good pattern. No issues.
  • Commit style section is useful for contributors.

No blocking issues. These files will improve onboarding for AI-assisted contributions.

This review was created by an AI agent (OpenHands) on behalf of @jssmith.

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