chore: add AI agent context files (AGENTS.md, USERS.md, conventions) - #459
Open
e-lo wants to merge 3 commits into
Open
chore: add AI agent context files (AGENTS.md, USERS.md, conventions)#459e-lo wants to merge 3 commits into
e-lo wants to merge 3 commits into
Conversation
…d development Implements #458. Adds tool-agnostic context files so any AI coding assistant gets consistent project context: - AGENTS.md: token-efficient root context with doc pointers and ecosystem overview - CLAUDE.md: thin Claude-specific file delegating to AGENTS.md - USERS.md: 4 user personas and UX principles for design decisions - docs/conventions.md: coding style, validation strategy, testing, commits - docs/design.md: 7 mermaid diagrams (object model, project flow, ecosystem, etc.) - CONTRIBUTING.md: diagram maintenance convention, expanded testing section Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
|
📚 Documentation has been built and deployed! View the docs for this PR: https://network-wrangler.github.io/network_wrangler/claude/agitated-wescoff/ |
…e design Adds three Anthropic Agent Skill-format guides at skills/ for AI coding assistants: root-cause debugging discipline, measure-first performance work, and user-persona + ecosystem-aware feature design. Readable by any skill-aware agent (Claude Code, Codex) and by humans directly. 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
1 participant
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
AGENTS.md(~400 tokens) so any AI coding assistant (Claude Code, Cursor, Copilot, Aider, Windsurf) gets consistent project contextCLAUDE.mdas a thin Claude-specific delegate toAGENTS.mdUSERS.mdwith 4 user personas (transportation planners, model developers, tool developers, CI/automation) and UX principlesdocs/conventions.mdcovering coding style, validation strategy (when/where to run pandera and FK checks), pandas/pandera/geopandas patterns, testing, and commitsdocs/design.mdwith 7 mermaid diagrams: ecosystem data flow, core object model, roadway selection, project application flow, scoped property resolution, IO pipelineCONTRIBUTING.mdwith diagram maintenance convention and expanded testing sectionCloses #458
Design Decisions
AGENTS.md+docs/. No tool-specific plugins committed to repo.AGENTS.mdis a concise index pointing todocs/conventions.md,docs/design.md,CONTRIBUTING.md,USERS.md. Details live in one place only.docs/design.mdreplace the need for per-directory context files.Test plan
mkdocs serverenders newdocs/conventions.mdand mermaid diagrams indocs/design.mdcorrectlyAGENTS.mdanddocs/conventions.mdUSERS.mdfor accuracy🤖 Generated with Claude Code