Skip to content

Add AGENTS.md with codebase guide for agentic tools#87

Merged
jstayton merged 1 commit into
developmentfrom
add-agents-md
May 8, 2026
Merged

Add AGENTS.md with codebase guide for agentic tools#87
jstayton merged 1 commit into
developmentfrom
add-agents-md

Conversation

@jstayton
Copy link
Copy Markdown
Collaborator

@jstayton jstayton commented May 8, 2026

Summary

  • Adds AGENTS.md documenting the QueryQL pipeline (Schema → Orchestrators → Parsers → Validators → Adapter), the two extension hooks (querier 'filter:<name>[<op>]' / adapter 'filter:<op>'), and the easily-confused default* vs *Defaults pair.
  • Includes the common dev commands (single-test invocation, watch, lint-fix, release flow) and notes the Node 20/22/24 CI matrix.
  • CLAUDE.md is a symlink to AGENTS.md so Claude Code picks up the same content without duplication.
  • Adds "agentic" to the cSpell wordlist so AGENTS.md's opening line doesn't trigger a warning.

Test plan

  • Confirm AGENTS.md renders correctly on GitHub.
  • Confirm CLAUDE.md is shown as a symlink (→ AGENTS.md) on GitHub.
  • npm run lint still passes.
  • npm test still passes.

🤖 Generated with Claude Code

Documents the QueryQL pipeline (Schema → Orchestrators → Parsers →
Validators → Adapter), the two extension hooks, the easily-confused
default-vs-defaults pair, and common dev commands. CLAUDE.md is a
symlink to AGENTS.md so Claude Code picks up the same content.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@jstayton jstayton merged commit 0b84c73 into development May 8, 2026
4 checks passed
@jstayton jstayton deleted the add-agents-md branch May 8, 2026 13:24
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