GIT-013 recommended documentation

AI agent context file

CLAUDE.md or AGENTS.md provides context for AI agents

Question to ask

"Would an AI agent know what NOT to touch in this repo?"

Verification guide

Severity: Recommended

Check automatically:

ls -la CLAUDE.md claude.md AGENTS.md agents.md .claude/ 2>/dev/null

If found, verify contents:

  • Project overview/purpose
  • Key conventions and patterns
  • Important files/directories
  • How to work in this codebase

Pass criteria:

  • File exists (CLAUDE.md, AGENTS.md, or similar)
  • Contains useful context for AI assistants

Fail criteria:

  • No AI context file

If missing: "Consider adding CLAUDE.md with: project overview, conventions, key files, and any gotchas an AI assistant should know."

Evidence to capture:

  • File exists (yes/no)
  • Quality of content (basic vs comprehensive)

Section

01. Git Repo Setup & Security

Infrastructure & Setup