docs: document the pre-commit mockery hook in AGENTS.md#130
Merged
Conversation
AGENTS.md's repository-structure list described `.pre-commit-config.yaml` as "linting/spell-checking configuration" and omitted `.github/scripts/run-mockery.sh` entirely — but the pre-commit config's actual hooks are golangci-lint-fmt (Go formatting) and mockery mock generation via that script (lint/spell is `.mega-linter.yml` + `cspell.json`). Splits the bullet so each config is described accurately and adds a bullet for run-mockery.sh (a guarded no-op until a .mockery.yml/.yaml exists, so a fresh clone's hook stays green while the generation step is already wired). Keeps the agent file — read by Copilot code review and any agentic tool — in sync with what the repo actually does. Docs/prose only; no behaviour change. > 🤖 Generated by the Daily AI Assistant
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.
What & why
AGENTS.md's repository-structure list described
.pre-commit-config.yamlas "linting/spell-checking configuration" and omitted.github/scripts/run-mockery.shentirely. But the pre-commit config's actual hooks are:golangci-lint-fmt— Go formattingmockery— mock generation, via.github/scripts/run-mockery.sh(The lint/spell tooling is
.mega-linter.yml+cspell.json.) So the agent file — read by Copilot code review and any agentic tool — was both inaccurate about pre-commit and silent about a wired-in helper script.How
Splits the one bullet into accurate per-config bullets and adds a bullet for
run-mockery.sh, noting it's a guarded no-op until the project adds a.mockery.yml/.mockery.yaml(so a fresh clone's pre-commit hook stays green while the generation step is already wired).Docs/prose only — no behaviour change. Verified
run-mockery.shexists and is wired as themockeryhook'sentryon livemain; the added lines introduce no new cspell findings.