add AGENTS.md to dbt-utils#23
Conversation
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
PR Summary:
- Adds
AGENTS.mdto orient AI agents to this Clearcover fork of dbt-utils - Covers quick-start commands, domain position, tech stack, project structure, and hard boundaries
- Adds
CLAUDE.mdas a one-liner that delegates toAGENTS.md - Content was generated and purportedly verified by two autonomous agent passes
Review Summary:
The document is well-structured and covers the right surface area for an agent-orientation file. Verified all quick-start commands against actual repo files (run_test.sh, integration_tests/Makefile, dbt_project.yml). Three issues found:
- The footer disclaimer ("not manually verified") directly contradicts the PR description's claim of a full verification pass — this creates a trust/credibility inconsistency in the document itself.
- The
make testquick-start command must be run fromintegration_tests/(the Makefile lives there and references../docker-compose.yml), but the code block mixes repo-root and subdirectory commands without making working directories explicit. - "Python 3.9" is asserted with no backing evidence — no
.python-version,pyproject.toml, orsetup.cfgexists in the repo;run_test.shonly callspython3.
Follow-up suggestions:
- @devloai fix the identified issues in AGENTS.md (disclaimer contradiction, working directory clarity, unverified Python version)
| **Ask first:** new adapter-specific implementations · changes to cross_db_utils (affects all adapters) · schema test signature changes (breaking for consumers) | ||
| **Never:** push to main/master · skip failing tests · add business logic (this is a utility library only) | ||
|
|
||
| > Auto-generated by AI agent via blind repo scan. Contents reflect observed code at time of generation — not manually verified. Review and update when this repo next changes meaningfully. |
There was a problem hiding this comment.
The footer disclaimer directly contradicts the PR description, which claims a second agent "audited every command, path, and name against actual files" and followed "be right or be silent." One of these must be wrong — and leaving "not manually verified" here means any future agent reading this file may distrust its own content unnecessarily, or worse, the disclaimer gets propagated into derived docs.
If the content was verified, remove the disclaimer. If it wasn't, the PR description is overstated. Either way, this line should be reconciled.
| > Auto-generated by AI agent via blind repo scan. Contents reflect observed code at time of generation — not manually verified. Review and update when this repo next changes meaningfully. | |
| > Last updated: [date]. Review and update when this repo next changes meaningfully. |
actions
Quick Fix: Apply a small focused fix for this specific issue (takes < 1min).
Feedback: Rate this comment to help me improve future code reviews:
- 👍 Good - Helpful and accurate
- 👎 Poor - Wrong, unclear, or unhelpful
- Skip if you don't have any strong opinions either way.
| ./run_test.sh postgres | ||
|
|
||
| # Run via Docker (from integration_tests/) | ||
| make test target=postgres |
There was a problem hiding this comment.
The make test command must be run from the integration_tests/ directory (where the Makefile lives, and it references ../docker-compose.yml), not the repo root. The preceding command (./run_test.sh) is run from the repo root. The visual grouping under a single code block without an explicit cd can confuse an agent following these steps sequentially.
Suggest making the working directory self-contained:
# Run via Docker — from repo root
cd integration_tests && make test target=postgresactions
Quick Fix: Apply a small focused fix for this specific issue (takes < 1min).
Feedback: Rate this comment to help me improve future code reviews:
- 👍 Good - Helpful and accurate
- 👎 Poor - Wrong, unclear, or unhelpful
- Skip if you don't have any strong opinions either way.
|
|
||
| ## Tech stack | ||
|
|
||
| - **Language/runtime:** Jinja2/SQL (dbt macros), Python 3.9 (test runner) |
There was a problem hiding this comment.
"Python 3.9" is stated as fact but there's no pyproject.toml, .python-version, or setup.cfg in this repo that pins a Python version. run_test.sh only calls python3 without a version constraint. This is an inference that could mislead agents into assuming version-specific behavior.
Suggest being conservative:
| - **Language/runtime:** Jinja2/SQL (dbt macros), Python 3.9 (test runner) | |
| - **Language/runtime:** Jinja2/SQL (dbt macros), Python 3 (test runner — version not pinned) |
actions
Quick Fix: Apply a small focused fix for this specific issue (takes < 1min).
Feedback: Rate this comment to help me improve future code reviews:
- 👍 Good - Helpful and accurate
- 👎 Poor - Wrong, unclear, or unhelpful
- Skip if you don't have any strong opinions either way.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
🤖 AI review complete — seeking human approvalThis Please verify:
If anything is wrong, just edit 🤖 Generated with Claude Code · |
Summary
Adds
AGENTS.mdto give AI agents working in this repo instant orientation:Process
Generated and verified in two autonomous passes:
removed anything it could not confirm ("be right or be silent")
🤖 Generated with Claude Code
Co-Authored-By: Claude Sonnet 4.6 noreply@anthropic.com