From c849891368ee58385f0ff274dc71c52ee6c1b7f1 Mon Sep 17 00:00:00 2001 From: billdmar Date: Thu, 13 Aug 2026 15:31:33 -0700 Subject: [PATCH 1/2] docs: restore G1/G2 gate labels stripped by an over-eager edit Headline table, verification narrative, and reproduce commands had empty () and double-spaces where the G1/G2 gate names (matching TestSeedSweepG1/G2 in CI) were accidentally removed. Restores them; fixes the registry.go comment likewise. --- README.md | 14 +++++++------- config/registry.go | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0ccc5a4..1b75beb 100644 --- a/README.md +++ b/README.md @@ -23,12 +23,12 @@ busy machine or a non-release build. | Metric | Result | |---|---| -| Verified runs — verification () | **10,000** (1,000 seeds × 5-schedule base matrix × {3,5} nodes) | -| Verified runs — full gate () | **140,000** (10,000 seeds × 7-schedule full matrix × {3,5} nodes) | +| Verified runs — verification (G1) | **10,000** (1,000 seeds × 5-schedule base matrix × {3,5} nodes) | +| Verified runs — full gate (G2) | **140,000** (10,000 seeds × 7-schedule full matrix × {3,5} nodes) | | Raft safety-invariant violations | **0** | | Non-linearizable histories (Porcupine) | **0** | | Defects found & fixed by the verification process | 7 (2 pinned as regression seeds: `507`, `7503`) | -| Core-package coverage | **95.3%** (unit tests ∪ the sweep) | +| Core-package coverage | **95.3%** (unit tests ∪ the G2 sweep) | | Crash-recovery | converges under `crashy` + `disk-faulty` (kills at fsync boundaries) | | Concurrency safety | `go test -race` clean; 60-run robustness sweep, 0 races | | Throughput (3-node loopback, unbatched, 32 clients) | **~117k ops/sec**, p50 0.05 ms, **p99 4.8 ms** | @@ -82,7 +82,7 @@ stack possible. Every failing seed becomes a **committed regression test**, and no fault schedule, seed floor, or invariant bound is *ever* relaxed to turn a red run green. The verification process found **seven real defects**: six during the gated build (two -at the verification, four at the full gate — each in the test harness or a +at the G1 verification, four at the G2 full gate — each in the test harness or a monitor, none in Raft safety), plus one in the P6 membership feature caught by an adversarial code review (log compaction silently reverted committed cluster membership). Each was fixed at the root and pinned by a regression test — written @@ -114,13 +114,13 @@ CLIENTS=N1=127.0.0.1:8001,N2=127.0.0.1:8002,N3=127.0.0.1:8003 ## Reproduce every number ```sh -# verification (): 10,000 verified runs, base matrix × {3,5} nodes. +# verification (G1): 10,000 verified runs, base matrix × {3,5} nodes. go test ./tests/integration/ -run TestSeedSweepG1 -timeout 30m -args -seeds=1000 -# Full gate (): 140,000 verified runs, full matrix × {3,5} nodes. +# Full gate (G2): 140,000 verified runs, full matrix × {3,5} nodes. go test ./tests/integration/ -run TestSeedSweepG2 -timeout 60m -args -seeds=10000 -# Core coverage (95.3%): merge unit-test coverage with the sweep's coverage. +# Core coverage (95.3%): merge unit-test coverage with the G2 sweep's coverage. D=$(mktemp -d) go test -coverpkg=./core/... ./core/... -args -test.gocoverdir=$D go test -coverpkg=./core/... ./tests/integration/ -run TestSeedSweepG2 -args -seeds=200 -test.gocoverdir=$D diff --git a/config/registry.go b/config/registry.go index f8eda5e..493a18a 100644 --- a/config/registry.go +++ b/config/registry.go @@ -6,7 +6,7 @@ // REGISTRY RULE (critical): nothing in this file is ever weakened to // turn a red run green. A violation means investigate the bug, fix it, and // commit the failing seed as a regression test — never relax a bound, shrink a -// sweep, or drop a schedule. Changes here go through the only and +// sweep, or drop a schedule. Changes here go through code review only and // must update the justification alongside the value. package config From f906deb8a528d1ca638eee74660df5e1b2fbf993 Mon Sep 17 00:00:00 2001 From: billdmar Date: Thu, 13 Aug 2026 16:23:35 -0700 Subject: [PATCH 2/2] docs: add descriptive H1 tagline MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit '# quorum' -> '# quorum — verified Raft consensus & replicated KV in Go'. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1b75beb..dd00fc9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# quorum +# quorum — verified Raft consensus & replicated KV in Go [![CI](https://github.com/billdmar/quorum/actions/workflows/ci.yml/badge.svg)](https://github.com/billdmar/quorum/actions/workflows/ci.yml) [![Go 1.23](https://img.shields.io/badge/Go-1.23-00ADD8?logo=go&logoColor=white)](go.mod)