Add AGENTS.md and CLAUDE.md for AI agent guidance#656
Open
rtibbles wants to merge 2 commits intolearningequality:mainfrom
Open
Add AGENTS.md and CLAUDE.md for AI agent guidance#656rtibbles wants to merge 2 commits intolearningequality:mainfrom
rtibbles wants to merge 2 commits intolearningequality:mainfrom
Conversation
Tested via TDD methodology against a KPUB file type implementation task — iteratively refined through RED/GREEN/REFACTOR cycles to ensure subagents correctly scope changes to the pipeline and avoid unnecessary File/Node subclass creation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Create a concise, model-agnostic AGENTS.md with commands, critical gotchas, and key architecture for all AI coding agents. Restructure CLAUDE.md to import AGENTS.md via @ reference and extend with Claude-specific architecture details. AGENTS.md was validated through 3 rounds of TDD testing (RED-GREEN- REFACTOR) with Haiku and Sonnet subagents using a KPUB file type implementation task to verify gotcha effectiveness. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add two documentation files to guide AI coding agents working in this repository:
AGENTS.md— Concise, model-agnostic guidance (36 lines) with commands-first layout, critical gotchas, project overview, and key architecture. Designed to fit in smaller context windows.CLAUDE.md— ImportsAGENTS.mdvia@AGENTS.mdreference and adds Claude Code-specific extensions: detailed pipeline architecture,le_utilsdependency context, and expanded file type implementation guidance.The
AGENTS.mdcontent was validated through 3 rounds of TDD testing (RED-GREEN-REFACTOR) using Haiku and Sonnet subagents with a KPUB file type implementation task. Each round identified common agent mistakes and refined the gotchas to prevent them. Key gotchas that proved effective:classes/modulesle_utilsconstant verification before use (names are non-obvious)tests/pipeline/References
Follows the AGENTS.md / CLAUDE.md split pattern from Kolibri PR #14164.
Reviewer guidance