Repository navigation
docs(agents): AGENTS.md canonical + docs-vs-code precedence rule - #62
Merged
Merged
Conversation
Add canonical agent instructions with docs-vs-code precedence rule, generated-code guardrails, and verified dev commands. CLAUDE.md imports AGENTS.md per Claude Code shim pattern. Co-authored-by: Yu Ishikawa <yu-iskw@users.noreply.github.com>
|
Caution Review failedThe pull request is closed. Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
yu-iskw
marked this pull request as ready for review
October 25, 2026 07:32
|
ⓘ Qodo reviews are paused because the subscription is no longer active. Ask your workspace admin to reactivate the subscription to resume reviews. Manage billing |
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
Documentation-only change for coding agents (context: arXiv 2610.30571, yu-iskw/TODO#304).
AGENTS.mdas the canonical instruction file: project overview, verbatim “When documentation and code disagree” section, generated-client guardrails, and dev commands (each cited to its defining file).CLAUDE.mdas a thin shim (# CLAUDE.md, then@AGENTS.md) so Claude Code loads shared guidance.No source, test, CI, dependency, or generated-file changes.
Files changed
AGENTS.mdCLAUDE.mdCLAUDE.md handling
# CLAUDE.mdH1, blank line,@AGENTS.md, HTML comment, empty## Claude Codesection (no Claude-only content existed to preserve)Inconsistencies found
Audited
AGENTS.md(new),README.md,Makefile,pyproject.toml,dev/setup.sh,dev/generate_clients.sh,dev/openapi-python-client.yml,.github/workflows/test.yml, andlightdash_client/__init__.py. No.cursor/rules,GEMINI.md,.github/copilot-instructions.md,.claude/settings.json, ordocs/adrpresent.Makefilebuildtarget runslintbeforeflit buildMakefile:42-43,.github/workflows/test.yml:35-37pyproject.toml[project.optional-dependencies]dev pinsflit ==3.10.1dev/setup.shinstallsflit==3.9.0beforeflit installpyproject.toml:65,dev/setup.sh:24-25dev/openapi-python-client.ymlpackage_version_override: 0.2.0lightdash_client.__version__ == "0.1471.0"dev/openapi-python-client.yml:6,lightdash_client/__init__.py:10Makefileseveral targets use.PHONE.PHONYas phony;.PHONEis not specialMakefile:22,Makefile:37Uncertainties
lightdash_client/__init__.py__version__is intentionally maintained outside the openapi-python-client generator (it is not overwritten bydev/generate_clients.shrsync).AGENTS.mdvs hypothetical future.cursor/rulesis not documented by Cursor; not applicable today (no project rules).Local checks
pre-commit run --files AGENTS.md CLAUDE.md— passed (EOF, trailing whitespace, ruff hooks).bash dev/test_python.sh— passed (1 test).