Skip to content

Commit 483f6af

Browse files
committed
docs(alpha-readiness): pin the "showable .NET alpha" gate + honest status
Records the wedge strategy (one delicious stack, prove the core isn't bolted to it: 80% .NET / 20% one spike) and answers "are we ready to show people yet?" with a concrete A-G gate mapped to the actual repo state on 2026-06-27: - B (GitHub Action), C (SARIF/annotations), D (5+ diagnostics: OWN/DI/POOL/WPF), E (12 test-pinned bad/ok examples) are BUILT. - A (single `ownsharp check MyApp.sln` dotnet tool), F (3 packaged real-world case studies), G (consolidated suppression + false-positive page) are PARTIAL. - Plus the real front-door gap: README is still a Russian PoC doc, no 20-second landing / copy-paste install / Action quickstart. Verdict: capability is past alpha; the gap to "people install it" is packaging and presentation, not analysis power. The 20% rule caps other-stack work to one experimental rule each (experiments/owents-react-effect-cleanup, experiments/ownjava-listener-leak), keeping P-017/P-020 horizon/draft. ROADMAP points at the gate from the Priorities section. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QnGqHwVb2H1jZ71f498MFa
1 parent dca5b52 commit 483f6af

2 files changed

Lines changed: 104 additions & 0 deletions

File tree

‎docs/ROADMAP.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,13 @@ ownership/lifetime/effects, (4) an MVP needs no PhD in Roslyn.
131131
| **P2** | async resource lifecycle; `ValueTask` affine usage; typestate/protocols | [P-008](proposals/P-008-effects-and-resources.md), [P-010](proposals/P-010-type-disciplines.md) |
132132
| **P3** | LOH fragmentation; static-collection memory bloat; cross-thread `ObjectDisposedException` | — (runtime-bound; see detectability matrix) |
133133

134+
> **Are we showable yet?** The concrete "delicious .NET alpha" gate — the A–G bar
135+
> (`dotnet tool` / Action / SARIF / 5 diagnostics / bad-ok examples / case studies /
136+
> suppression policy), the honest current status against it, and the 80/20 rule —
137+
> lives in [docs/notes/alpha-readiness.md](notes/alpha-readiness.md). Short version:
138+
> capability is past alpha; the gap to "people install it" is *packaging* (a single
139+
> `ownsharp check MyApp.sln` CLI, a wedge landing README, packaged case studies).
140+
134141
**The five concrete diagnostics to build first** (balanced across real pain,
135142
architectural strictness, and the borrow-checker showcase):
136143

‎docs/notes/alpha-readiness.md‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# "Delicious .NET alpha" — the showable-to-people gate
2+
3+
Working note. The strategy is **not** "spread across stacks" — it is *"make one
4+
stack delicious, and architecturally prove the core isn't bolted to it."* Concretely:
5+
**80% of effort → .NET to "damn, it actually found a leak in my project,"** **20% →
6+
one tiny spike in another stack** to back the platform-agnostic story (P-017/P-020).
7+
A zoo of half-built frontends is cute until you have to deploy it.
8+
9+
This note answers one recurring question — **"are we ready to show people yet?"** —
10+
by pinning a concrete gate and the *honest* current status against it. It is an
11+
assessment, not a promise; status reflects a read of the repo on 2026-06-27.
12+
13+
## The wedge (what we sell, what we refuse to)
14+
15+
Do **not** pitch as: a static analyzer / AI code reviewer / SAST / borrow checker
16+
for C# / multi-language bug finder. That arena belongs to Sonar/CodeQL/Semgrep/Snyk
17+
and their sales teams; see
18+
[ROADMAP — Positioning against the competition](../ROADMAP.md#positioning-against-the-competition-not-another-sast).
19+
20+
Sell the narrow clin:
21+
22+
> **Own.NET finds .NET lifetime/resource bugs: event leaks, timer leaks, missing
23+
> `Dispose`, DI lifetime capture, and pooled-buffer misuse** — the class of bug that
24+
> sends people to dotMemory to argue with their monitor.
25+
26+
Slogans on record (for posts, README, talks):
27+
- *Find leaks before the profiler.*
28+
- *GC collects unreachable objects; Own finds objects that should have become unreachable.*
29+
- *`event +=` is acquire, `-=` is release.*
30+
- *Not all lifecycle bugs leak memory — some leak requests.* (the Cloudflare-style post — P-020)
31+
32+
## The gate (A–G) and where we actually stand
33+
34+
The bar for "showable": a person can reproduce the wow in ~3 minutes
35+
(`install → run → it found my real dirt`).
36+
37+
| | Item | Status (2026-06-27) | Gap to close |
38+
|---|------|--------------------|--------------|
39+
| **A** | `dotnet tool` one-command CLI | ◑ **partial** — the *extractor* is `PackAsTool` (`ownsharp-extract`, P-013); the core is Python. The delightful `ownsharp check MyApp.sln` single tool isn't packaged. | Wrap extractor+core into one `dotnet tool` (or a self-contained CLI) that takes a `.sln`/dir and prints findings. |
40+
| **B** | GitHub Action | ✅ **built** — `action.yml`: `path`/`severity`/`format` (github / msbuild / human / sarif), purple shield branding. Matches the "stupidly simple YAML" bar. | Publish to Marketplace; pin the 6-line usage in the README. |
41+
| **C** | SARIF / PR annotations | ✅ **built** — SARIF 2.1.0 + GitHub annotations + reachability/evidence (P-015). | — |
42+
| **D** | 5 core diagnostics | ✅ **built, well past** — OWN001/002/003, OWN014, DI001–005, POOL001–005, WPF001–005 (catalog). The comment's `SUB001/SUB002/TMR001/DISP001/DI001` all exist *semantically*; the `SUB/TMR/DISP` catalog rename is the deferred consolidation item, not new work. | (naming only) land the catalog rename with the OwnIR-v1/profile-label work. |
43+
| **E** | 10 bad/ok examples | ✅ **built** — 12 test-pinned gallery cases (`examples/gallery/`, incl. `00_ok_clean`) + extractor samples. | Add `.cs`-native (not `.own`) bad/ok pairs for the C# audience. |
44+
| **F** | 3 real-world case studies | ◑ **partial** — one honest mining write-up (`real-world-mining.md`: Dapper, CsvHelper, **ScreenToGif** flagship `VideoSource` + two `SystemEvents` leaks, all TPs, clean on disciplined libs) + a 20-case `corpus/real-world/`. Raw material for 3 studies exists; the *packaged* studies don't. | Write 3 `bad → fixed → what others miss → how Own reports it` studies from existing finds. |
45+
| **G** | suppression + false-positive policy | ◑ **partial** — `[OwnIgnore("reason")]` designed (P-004), project-wide config is P-015 (draft); precision behaviour is strong & documented ("no FP from `using`"). | One consolidated user-facing page: suppression mechanism + explicit FP policy. |
46+
47+
**Plus the front door (not in A–G but the real blocker):** `README.md` is still
48+
`# OwnLang — PoC` — deep, Russian, research-framed. There is **no 20-second landing /
49+
copy-paste install / Action quickstart** at the top. Per the comment's own
50+
open-source-path list (README-in-20s → copy-paste → bad/ok → Action → SARIF →
51+
suppression → "why not Sonar/CodeQL"), this is the highest-leverage missing piece.
52+
53+
## Honest verdict
54+
55+
**The engine is past alpha on *capability* (D/E strong, B/C built). The gap to
56+
"showable" is *packaging and presentation*, not analysis power:**
57+
58+
1. a single `ownsharp check MyApp.sln` tool (**A**);
59+
2. a wedge landing README + copy-paste quickstart (front door);
60+
3. three packaged case studies from finds we already have (**F**);
61+
4. one consolidated suppression / false-positive page (**G**).
62+
63+
None of those is research; all are the difference between "interesting PoC" and
64+
"people install it." That ordering *is* the day 1–30 milestone.
65+
66+
## The 20% rule (other stacks)
67+
68+
Other stacks are **proof of portability, not a second product.** Sanctioned now:
69+
**at most one rule each**, as experiments — not an OwnTS 1.0.
70+
71+
```
72+
experiments/
73+
owents-react-effect-cleanup/ # P-020: useEffect listener/effect, the PR/marketing spike
74+
ownjava-listener-leak/ # P-017: addListener w/o removeListener → same OwnIR, the model proof
75+
```
76+
77+
README framing, and no more: *"Experimental: the same OwnIR model can represent
78+
React effect cleanup and Java listener lifetimes."* Design lives in
79+
[P-017](../proposals/P-017-multi-stack-frontends.md) /
80+
[P-020](../proposals/P-020-ownts-react-effects.md); both stay `horizon`/`draft`
81+
until the .NET alpha above is delicious. Do not let the spike exceed 20%.
82+
83+
## 90-day shape (sequencing, not a schedule)
84+
85+
- **Days 1–30 — make the .NET alpha tasty:** close A, the README front door, F, G
86+
(B/C/D/E already done). Suppression UX + bad/ok corpus polish.
87+
- **Days 31–60 — real-world proof:** run over 20–50 OSS .NET/WPF/Avalonia/WinForms
88+
repos; table of findings / confirmed / FP / unsupported; 2 case studies; compare
89+
with CodeQL / NetAnalyzers / Infer# where possible (the oracle, `docs/notes/oracle.md`).
90+
- **Days 61–90 — public launch:** landing README, "WPF zombie ViewModels" post,
91+
HN/Reddit/dev.to/.NET community, Action on Marketplace, `good first spec` issues,
92+
feedback from WPF/Avalonia/WinForms maintainers. The React/Java spike runs in
93+
parallel — capped at 20%.
94+
95+
The standing priority is unchanged: **prove value, don't reshape form**
96+
([consolidation-and-positioning.md](consolidation-and-positioning.md)). This note is
97+
the concrete "what value, packaged how" gate for that.

0 commit comments

Comments
 (0)