Skip to content

Commit f643e96

Browse files
dzhelezovclaude
andauthored
docs(contributing): state the definition-of-done principle before Pins (#132)
The Pins section codifies how example version pins move, but not the broader principle it implies: a user-facing fix is not done at merge to main. Examples run the published @subsquid/ponder package pinned in each package.json/e2e.json, not the repo working tree — so a fix is neither user-reproducible nor visible in example behavior until a version carrying it is published and the pins advance through the release flow, green under the examples e2e gate. Add a short "Definition of done" subsection ahead of Pins that states this crisply and leans on the existing Pins mechanics rather than restating them. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 2aca207 commit f643e96

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,15 @@ E2E_RPC_URL_1=<archive-rpc> node scripts/examples-e2e.mjs euler-subgraph
3030
The harness never prints RPC URLs. If the env var is unset, the example's public default RPC remains
3131
in use.
3232

33+
## Definition of done
34+
35+
A user-facing fix is not done when it merges to `main`. The examples run the **published**
36+
`@subsquid/ponder` package pinned in each `package.json`/`e2e.json`, not the repo working tree, so a
37+
fix on `main` is neither reproducible by a user nor visible in example behavior until a version
38+
carrying it is published to npm and the example pins have advanced to that version through the
39+
release flow (see below). Merged to `main` is not user-safe; a version published and pinned, green
40+
under the examples e2e gate, is.
41+
3342
## Pins
3443

3544
Each example pins an exact `@subsquid/ponder` version in both `package.json` and `e2e.json`.

0 commit comments

Comments
 (0)