Skip to content

add AGENTS.md to dbt-utils#23

Draft
jsr6720 wants to merge 2 commits into
masterfrom
chore/no-ticket-add-agents-md
Draft

add AGENTS.md to dbt-utils#23
jsr6720 wants to merge 2 commits into
masterfrom
chore/no-ticket-add-agents-md

Conversation

@jsr6720

@jsr6720 jsr6720 commented Mar 7, 2026

Copy link
Copy Markdown
Member

Summary

Adds AGENTS.md to give AI agents working in this repo instant orientation:

  • What this service does and where it fits in Clearcover's platform
  • Domain position (layer, domain, what it owns, who calls it, what it calls)
  • Quick start commands (install, test, lint, build) — verified against actual repo files
  • Tech stack, project structure, code style, and git workflow
  • Hard boundaries (what the agent must never do)

Process

Generated and verified in two autonomous passes:

  1. Generation — agent scanned the repo and wrote AGENTS.md
  2. Verification — second agent audited every command, path, and name against actual files;
    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

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

@devloai devloai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Summary:

  • Adds AGENTS.md to 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.md as a one-liner that delegates to AGENTS.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:

  1. 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.
  2. The make test quick-start command must be run from integration_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.
  3. "Python 3.9" is asserted with no backing evidence — no .python-version, pyproject.toml, or setup.cfg exists in the repo; run_test.sh only calls python3.

Follow-up suggestions:

  • @devloai fix the identified issues in AGENTS.md (disclaimer contradiction, working directory clarity, unverified Python version)

Comment thread AGENTS.md Outdated
**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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
> 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.

Apply quick fix

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.

Comment thread AGENTS.md Outdated
./run_test.sh postgres

# Run via Docker (from integration_tests/)
make test target=postgres

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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=postgres

Apply quick fix

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.

Comment thread AGENTS.md Outdated

## Tech stack

- **Language/runtime:** Jinja2/SQL (dbt macros), Python 3.9 (test runner)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"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:

Suggested change
- **Language/runtime:** Jinja2/SQL (dbt macros), Python 3.9 (test runner)
- **Language/runtime:** Jinja2/SQL (dbt macros), Python 3 (test runner — version not pinned)

Apply quick fix

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>
@jsr6720

jsr6720 commented Mar 8, 2026

Copy link
Copy Markdown
Member Author

🤖 AI review complete — seeking human approval

This AGENTS.md was generated in two autonomous passes (generation + accuracy verification), then devloai inline comments were addressed.

Please verify:

  • Domain position — layer, domain, what it owns, who calls it, what it calls
  • Quick start commands — do these work in your local dev setup?
  • Project structure — does the tree reflect reality?
  • Any items flagged "for human review" inside the AGENTS.md itself

If anything is wrong, just edit AGENTS.md directly on this branch and push — no need to close and reopen.


🤖 Generated with Claude Code · Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant