docs: record the module-shape, cleanup, and review-shape conventions - #735
Open
lneto wants to merge 8 commits into
Open
docs: record the module-shape, cleanup, and review-shape conventions#735lneto wants to merge 8 commits into
lneto wants to merge 8 commits into
Conversation
A module that makes objects returns a class or namespace table and constructs through .new or a :__call method; a proxy's metamethods do not allocate per access. A test's cleanup covers every case's runtime, not only the happy path's, so a case that fails before its inline teardown does not wedge the next run. A review measures a new module's shape against its nearest sibling, not only its logic.
A CAPS <const> marks a scalar; a lookup or allow-list table is a lowercase name by role. A function's contract is read from its body, not inferred from its name or its place in a method table. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
A call the conventions here already answer is decided and noted, not put to the maintainer; a question is reserved for a genuine fork no rule, precedent, or test resolves. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
When new code diverges from the base, check which side is right before aligning; pulling it down to match a sibling that is itself behind is the wrong fix. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
lneto
force-pushed
the
claude_agents_conformance
branch
from
August 22, 2026 12:28
06f3ea5 to
74c6a06
Compare
When the pull request updates, re-fetch the author's branch and diff their new head against what you last saw; re-reading your own review branch reviews your work, not theirs. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
A comment saying it looks good leaves an earlier request-for-changes standing and the merge gate closed; the approval is what clears it. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Show the exact text and get the go-ahead on it before posting; the approval is of the words, not the intent. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…onsumer An artifact with no test of its own is run directly before a verdict, not just built. Reshaping or renaming an API means updating every consumer, grepped for, including ones in stacked pull requests that rebase onto the change. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
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.
Conventions the tree already follows but AGENTS.md did not record, each drawn from a place a review missed them.
Lua style
.newor a:__callmethod on the class (hkdf,inet), never a bare function or a metatable wrapped around the module; the underlying handle sits in a named field, not one prefixed with an underscore; the instance metatable is named for what it is, notmt.bpf.map'sviewshows.<const>marks a scalar; a lookup, dispatch, or allow-list table is a lowercase name by role (codecs,tokens), never caps.Deciding what to change
connmarkreads and writes despite sitting among read-only accessors).Tests
Reviewing
Docs only.