23 lines
2.0 KiB
Markdown
23 lines
2.0 KiB
Markdown
# Rules
|
|
|
|
- Go runs only through `docker compose run --rm <test|vet|fmt|build|cyclo>`; the merge gate is `docker build .` plus CI's changelog check.
|
|
- Tests first, in their own commit; the implementation follows in the next. A re-pin of seeded output or of `testdata/shipped_shape.txt` is its own commit.
|
|
- A change under `data/` or to the shape pin adds its `CHANGELOG.md` entry under `Unreleased` in the same PR, and so does a change to a flag, an exit code, an exported name, a fence, a builtin or the lowest Go; what is major is the README's Versioning table.
|
|
- One-line commit messages: no ticket prefix, no repo name, no authorship trailers.
|
|
- GitHub is where the project lives, so `gh` is the tool: merges are fast-forward
|
|
only, `gh pr merge --rebase` where the branch is already on top of main.
|
|
- README goal 2 is gated at 7.0 on the `comprehension-panel` skill, and below it
|
|
nothing else merges — no feature, no category, no data — bar a security fix, a
|
|
dependency bump and the infrastructure the round itself runs on. `todo.md` carries the round: the nine-seat findings run at depth 1,
|
|
a PR per item it names, then the run again, until the score passes. At or above 7.0
|
|
every pull request scores with the four-seat run and answers it in one run. No merge
|
|
lowers the last score.
|
|
- Hard tabs. No comment by default; delete a restatement, a rationale, history, or a file preamble.
|
|
- One spelling per result: reject the other at `New`, and let the error name the spelling to use.
|
|
- A standing choice a reader would relitigate goes under Decisions in the README, not in a comment.
|
|
- Prose naming a source states what that source states: read the register's own field
|
|
before paraphrasing it, and name the register you read before claiming none
|
|
publishes a spelling.
|
|
- A README example is a `json` block that loads and renders as a category; `readme_test.go` runs every one.
|
|
- Cyclomatic complexity is gated at 14: the table-shaped dispatches (`linkParent`, `compileTemplate`, `renderEdges`) sit at it and stay whole; a function that would pass it is decomposed.
|