Skip to content

Commit ec1e24b

Browse files
dzhelezovclaude
andauthored
docs(contributing): add a review checklist for cold-start progress ticker (#135)
CI (e2e gate + biome) does not assert that the per-chain Portal progress ticker keeps advancing during a cold discovery scan on a dense source — `scanned=` must climb even while `blocks_streamed=0` so a healthy run is never mistaken for a hang. Add a Review checklist section reminding reviewers to confirm any change to `progressFingerprint` preserves the `discoveryScannedBlocks` field (locked by the scanned-only regression test in `portal-metrics.test.ts`) and to eyeball the ticker on an example PR's empty opening window. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 5aa12cf commit ec1e24b

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,20 @@ query in `e2e.json`. Check that with:
5858
node scripts/examples-e2e.mjs euler-subgraph --verify-docs
5959
```
6060

61+
## Review checklist
62+
63+
The e2e gate and `biome check` cover the mechanical checks. One behavior CI does not assert needs a
64+
human pass on any PR that touches the Portal progress path (`portal/portal-metrics.ts`) or an
65+
example:
66+
67+
- **Cold-start progress still advances.** On a fresh, dense source the first discovery scan can run
68+
across many blocks before the first commit lands. The per-chain progress ticker must keep moving
69+
through that cold window — `scanned=` climbs even while `blocks_streamed=0` — so a healthy run is
70+
never mistaken for a hang. `progressFingerprint` keeps this honest by including
71+
`discoveryScannedBlocks` (locked by a regression test in `portal-metrics.test.ts`). Confirm any
72+
change to the fingerprint preserves that field, and on an example PR eyeball the ticker output on
73+
an empty opening window to see `scanned=` advance.
74+
6175
## Code Style
6276

6377
Follow [CLAUDE.md](CLAUDE.md) for repository style. In particular: braces on multi-line control

0 commit comments

Comments
 (0)