docs: capture agent conventions in AGENTS.md and mz-* skills#37741
Open
antiguru wants to merge 1 commit into
Open
docs: capture agent conventions in AGENTS.md and mz-* skills#37741antiguru wants to merge 1 commit into
antiguru wants to merge 1 commit into
Conversation
Records durable, non-obvious project conventions that agents kept rediscovering, none of them enforced by existing tooling. AGENTS.md guidance: * debug_assert! side-effect footgun: the macro body compiles out under [profile.optimized] (bin/environmentd, mzcompose) and [profile.release], so a side effect written there is silently inert outside cargo test. * Sharpen the durable-names rule to vendor, customer, and account names, across code, comments, docs, specs, commits, PR bodies, and fixtures. mz-run skill: * bin/environmentd --reset DROPs the shared CockroachDB schemas, which are global across all worktrees, not per-worktree. * mz_environmentd::Config has three constructor sites, one in mz-sqllogictest, so cargo check -p mz-environmentd alone misses a new field. mz-test skill: * testdrive connection=mz_system needs an explicit postgres-connect line. * Batch sqllogictest files and use replace for nondeterministic ID drift. * Avoid LOAD GENERATOR COUNTER + mz_sleep in slt; split monotonic coverage. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
antiguru
marked this pull request as ready for review
July 20, 2026 08:34
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.
Records durable, non-obvious project conventions that agents kept rediscovering, none of them enforced by existing tooling.
AGENTS.md guidance:
debug_assert!side-effect footgun: the macro body compiles out under[profile.optimized](bin/environmentd, mzcompose) and[profile.release], so a side effect written there is silently inert outsidecargo test.mz-run skill:
bin/environmentd --resetDROPs the shared CockroachDB schemas, which are global across all worktrees, not per-worktree.mz_environmentd::Confighas three constructor sites, one inmz-sqllogictest, socargo check -p mz-environmentdalone misses a new field.mz-test skill:
connection=mz_systemneeds an explicitpostgres-connectline.replacefor nondeterministic ID drift.LOAD GENERATOR COUNTER+mz_sleepin slt; split monotonic coverage.Docs-only, no code or generated docs touched.
🤖 Generated with Claude Code