Skip to content

Add AGENTS.md with drift checks#40

Merged
splch merged 8 commits into
mainfrom
churchill/add-agents-md
May 11, 2026
Merged

Add AGENTS.md with drift checks#40
splch merged 8 commits into
mainfrom
churchill/add-agents-md

Conversation

@splch

@splch splch commented May 8, 2026

Copy link
Copy Markdown
Collaborator

Summary

Adds AGENTS.md to brief AI coding agents on repo conventions, plus tests that pin every value AGENTS.md duplicates from canonical configs.

Test plan

uv run pytest tests/test_docs_consistency.py — all passed.


Important

Most code in ionq_core/ is auto-generated and overwritten on regeneration.
See CONTRIBUTING.md for which files are safe to edit.

@splch splch requested a review from a team as a code owner May 8, 2026 22:54
Comment thread AGENTS.md
Comment thread AGENTS.md
Comment thread AGENTS.md Outdated
guenp
guenp previously approved these changes May 9, 2026

@guenp guenp left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Lgtm, just a few comments on pinned versions

natestemen
natestemen previously approved these changes May 11, 2026

@natestemen natestemen 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.

My first time seeing tests of documentation like this. Strikes me as a bit strange, but I can see it being useful when a lot of the development is AI-driven.

Comment thread AGENTS.md
@splch

splch commented May 11, 2026

Copy link
Copy Markdown
Collaborator Author

@natestemen this is the first time ive added drift detection to tests haha but it's useful for the case where:

  1. the information is likely to drift and
  2. it's bad if the information drifts

@splch splch dismissed stale reviews from guenp and natestemen via fb23ffe May 11, 2026 16:20
@splch splch merged commit e184d04 into main May 11, 2026
12 checks passed
@splch splch deleted the churchill/add-agents-md branch May 11, 2026 19:39
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.

3 participants