docs: one contributor pattern across the four projects - #51
Merged
Conversation
mossaic was the only one of the four projects without a DCO sign-off, so standardizing meant picking one rule. It now requires one, like termlens, launchbound and reconverge: git commit -s, checked by the same script they use, wired into commit-policy.yml beside the attribution check. The check runs over a pull request's own range, not the full history, so commits made before the policy existed are not retroactively failed — only what is proposed from here. AGENTS.md is new: a brief for coding agents, and useful to humans. CLAUDE.md points at it rather than duplicating it. Its second half, and CONTRIBUTING's sections 4 through 8, are generated from one string shared with the sibling projects and are byte-identical in all four — a contributor moving between them should meet one set of rules, and generating them is the only way to be sure they stay that way. The repo-specific sections keep their content and move down: terminal compatibility reports, adding a glyph, and code style are now 9, 10 and 11. The two links to the glyph section are updated, anchors included. Signed-off-by: Vyncint Ng <115854244+vyncint@users.noreply.github.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
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.
One pattern across termlens, mossaic, launchbound and reconverge, so a contributor learns the rules once.
AGENTS.md+CLAUDE.mdNew in all four.
AGENTS.mdis the canonical brief — layout, the exact build and test commands, the things that bite in this repo, and the three rules that fail CI.CLAUDE.mdpoints at it rather than duplicating it, so per-tool instructions cannot drift apart.Generated, not copied
The shared halves are produced from one string and are byte-identical in all four repos — verified by hash:
AGENTS.mdfrom "The rules that will fail CI" to the endCONTRIBUTING.mdsections 4 Commit conventions, 5 DCO, 6 AI tooling policy, 7 PR flow, 8 Release processCopying prose four times is how four projects end up with four subtly different rules. Sections 1–3 and anything after 8 stay each repository's own.
The AI policy, stated properly
It is the rule an agent is most likely to break, so it now says the whole thing in every repo:
.claude/settings.json(now in all four) turns co-author trailers off for agents that read repository settings; the CI check is the boundary. The docs give the exact recovery commands, because the fix is to rewrite the message, not to argue with the check.Also standardized
check-dco.shandcheck-no-ai-attribution.sh, byte-identical, both in.github/scripts/, both taking a commit range.docs/RELEASING.mdin all four, same shape, honest about where the processes genuinely differ.MAINTAINERS.mdin all four, so a contributor sees who reviews and how fast before they open a PR.