Write down how to commit, review, and land - #48
Merged
Merged
Conversation
In a trial on 2026-09-30, fresh agents with no owner settings were asked how to land a CLI change. Both found the checks and the release rules, but neither gave the full commit rules, the squash and rebase landing, or the Docs: line. Those lived only in the private service repository and in one person's global instructions. One answer told the colleague to add an agent co-author trailer and a "Generated with" footer, and one presented the review plugin as a shell command with no install step. CONTRIBUTING.md now holds those rules for this public repository, whose docs cannot link to the private one. The skills and service pages share them, so the page asks that a change reach all three, and it records a review in the same Review: line they use. AGENTS.md routes to it in one line, and the README links it by absolute URL because npm packages the README. The documentation test checks the new page's links and requires an entrypoint to reach it. It stays out of the npm package. The tracked harness settings enable the cross-review plugins for anyone who trusts the main checkout, and turn off one harness's commit and pull request attribution. The object form of that setting keeps the file readable by versions that reject a bare false. The other harness's attribution follows each user's account setting, which overrides any repository file, so the guide says to turn it off there and names the trailer and line to remove. A change to these files or to CONTRIBUTING.md changes what every contributor's agent does, so it now needs independent review. One harness's default sandbox blocks the npm registry and the local HTTP server that several tests start. This repository keeps that default, so the guide says which commands need approval. Worktrees under .claude/worktrees are now ignored by git, Prettier, and ESLint, which otherwise checked the nested checkout's files.
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.
Summary
Colleagues' agents see only the repository. In the baseline trial, neither agent gave the full commit rules, the squash and rebase landing, or the
Docs:line. One answer prescribed an agent co-author trailer.CONTRIBUTING.md(new, not packaged) holds the commit, pull request, independent review and landing rules shared with skills and the service repository, and verified setup for both harnesses..claude/settings.jsonturns off attribution and enablescodex-review;.codex/config.tomldeclaresclaude-review.AGENTS.mdroutes toCONTRIBUTING.md(1,982 of 2,048 bytes), and the new files join the review trigger. The README links the page by absolute URL..claude/worktrees/is ignored by git, Prettier and ESLint.Trial for public-repo-change: Codex 86 → 97, Claude 73 → 95.
Docs: added CONTRIBUTING.md and the PR template; updated AGENTS.md and README.
Validation
npm audit: cleannpm run check: passReview
Review: codex-review 0.7.3, max effort, focus file. Session
e7650aac-35a8-4c08-b4b9-8b5586e99ed0: approve. Session59127326-cce1-4e20-ac4a-4b9c73816450on the final wording alignment: Approve.