docs: add comprehensive AGENTS.md for AI coding agent - #38
Open
nickemmons wants to merge 2 commits into
Open
Conversation
Comprehensive documentation to help AI agents understand how to effectively contribute to this codebase, including: - Project overview and architecture diagram - Directory layout cheat-sheet - Key modules and data flow documentation - Generated code pipeline and Makefile targets - Development setup instructions (uv, make dev, tox) - Testing strategy and mocking patterns - Coding conventions and patterns (async-first, guard clauses, etc.) - Day-to-day task recipes - Common gotchas and troubleshooting tips - Contribution workflow
- Project overview and architecture (ASCII diagrams) - Directory structure with module responsibilities - Build/dev setup with uv and make targets - Testing strategy (unit + integration) - Common tasks and contribution workflow - Gotchas and sharp edges to avoid This guide helps AI agents (and humans) quickly understand the codebase and contribute effectively.
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
2 participants
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
Adds a comprehensive
AGENTS.mdguide to help AI coding agents (and humans) quickly understand and contribute to this codebase.What's Included
uv+makeworkflow, codegen commandsWhy
AI coding agents work best with quick context loading. This guide distills essential patterns, pitfalls, and workflows into a single reference file.