|
1 | | -## 2026-02-25 — Add Go section and fix body text in root README |
| 1 | +## 2026-02-25 — Review of: Add Go section and fix body text in root README |
2 | 2 |
|
3 | | -**Done:** Added Go Reference badge, Go installation section, Go quick-start example, and updated |
4 | | -body text in the root README to mention all six binding ecosystems (Python, Java, Go, Node.js, |
5 | | -WebAssembly, and C). |
| 3 | +**Verdict:** PASS |
6 | 4 |
|
7 | | -**Files changed:** |
| 5 | +**Summary:** Root README now includes Go Reference badge, Go installation section, Go quick-start |
| 6 | +example, updated Key Features bullet, and corrected "What is iscc-lib" body text listing all six |
| 7 | +binding ecosystems. The change is minimal, well-scoped, and matches the reference code in |
| 8 | +`packages/go/README.md` exactly. |
8 | 9 |
|
9 | | -- `README.md`: Added Go Reference badge (line 8), updated Key Features bullet to include Go (line |
10 | | - 24), fixed "What is iscc-lib" body text to list all six bindings (line 48), added Go |
11 | | - installation section with `go get` command between Java and WASM (lines 106-110), added Go |
12 | | - quick-start section with complete runnable example between Java and WASM (lines 156-185) |
| 10 | +**Verification:** |
13 | 11 |
|
14 | | -**Verification:** All six grep verification criteria pass: |
| 12 | +- [x] `grep 'pkg.go.dev' README.md` exits 0 — Go Reference badge present |
| 13 | +- [x] `grep 'go get github.com/iscc/iscc-lib/packages/go' README.md` exits 0 — Go install command |
| 14 | + present |
| 15 | +- [x] `grep 'iscc.NewRuntime' README.md` exits 0 — Go quick-start example present |
| 16 | +- [x] `grep 'Python, Java, Go, Node.js, WebAssembly, and C' README.md` exits 0 — body text fixed |
| 17 | +- [x] `grep 'Python, Java, Go, Node.js, WASM, and C FFI' README.md` exits 0 — Key Features updated |
| 18 | +- [x] `grep -c '### Go' README.md` outputs `2` — two Go sections (Installation + Quick Start) |
15 | 19 |
|
16 | | -1. `grep 'pkg.go.dev' README.md` — Go Reference badge present ✓ |
17 | | -2. `grep 'go get github.com/iscc/iscc-lib/packages/go' README.md` — Go install command ✓ |
18 | | -3. `grep 'iscc.NewRuntime' README.md` — Go quick-start example ✓ |
19 | | -4. `grep 'Python, Java, Go, Node.js, WebAssembly, and C' README.md` — body text fixed ✓ |
20 | | -5. `grep 'Python, Java, Go, Node.js, WASM, and C FFI' README.md` — Key Features updated ✓ |
21 | | -6. `grep -c '### Go' README.md` outputs `2` — two Go sections ✓ |
| 20 | +**Issues found:** |
22 | 21 |
|
23 | | -All 14 pre-commit hooks pass (`mise run check`). |
| 22 | +- (none) |
24 | 23 |
|
25 | 24 | **Next:** Documentation how-to guides (`docs/howto/go.md` and `docs/howto/java.md`) or address |
26 | 25 | tracked issues from issues.md (codec optimization, DataHasher buffer allocation, etc.). |
27 | 26 |
|
28 | | -**Notes:** The "What is iscc-lib" body text required careful line wrapping to ensure the full |
29 | | -language list (`Python, Java, Go, Node.js, WebAssembly, and C`) lands on a single grep-matchable |
30 | | -line after mdformat auto-wraps at 100 characters. Changed "bindings" to "language bindings" to add |
31 | | -enough characters to push "Python" to the start of the next line, producing a stable wrapping that |
32 | | -mdformat doesn't re-break. |
| 27 | +**Notes:** All 14 pre-commit hooks pass. Only `README.md` was modified (no code changes). Go section |
| 28 | +ordering is Rust → Python → Node.js → Java → Go → WASM, consistent in both Installation and Quick |
| 29 | +Start. The mdformat-safe rewording trick (using "language bindings" to control line wrapping) is |
| 30 | +noted in advance agent memory for future reference. |
0 commit comments