diff --git a/README.md b/README.md index 2baaab4..7494af1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
-# Issue2Dev +Issue2Dev Banner ### Repository-aware implementation planning for GitHub issues. @@ -58,13 +58,13 @@ This is the core differentiator. Most "issue → plan" tools flatten the issue i | | Raw issue text | Generic LLM summary | **Issue2Dev** | | ---------------------------- | :------------: | :-----------------: | :-----------: | -| Repository-aware | ❌ | ⚠️ shallow | ✅ `RepositoryContext` | -| Deterministic / reproducible | ✅ | ❌ | ✅ | -| Evidence & provenance | ❌ | ❌ | ✅ per claim | -| Confidence-labeled heuristics| ❌ | ❌ | ✅ | -| Works fully offline | ✅ | ❌ | ✅ (`--from-file`) | -| Treats issue text as untrusted| n/a | ⚠️ usually no | ✅ | -| No vendor / API key required | ✅ | ❌ | ✅ | +| Repository-aware | No | Partial shallow | Yes `RepositoryContext` | +| Deterministic / reproducible | Yes | No | Yes | +| Evidence & provenance | No | No | Yes per claim | +| Confidence-labeled heuristics| No | No | Yes | +| Works fully offline | Yes | No | Yes (`--from-file`) | +| Treats issue text as untrusted| n/a | Partial usually no | Yes | +| No vendor / API key required | Yes | No | Yes | > [!IMPORTANT] > Issue2Dev's heuristics are intentionally modest and clearly labeled. Affected-file predictions, architecture inference, and risk hotspots are **confidence-scored guesses grounded in evidence**, not certainties. The point is an honest, inspectable starting context — not magic. @@ -118,15 +118,15 @@ The public CLI is intentionally thin. Both local fixtures and read-only GitHub i | Implemented in v0.1 | | | --- | --- | -| 🧠 **Repository Intelligence Engine** | Builds a bounded `RepositoryContext` from issue + repository signals. | -| 🩺 **Engineering diagnosis** | Deterministic root-cause hypotheses, solution strategy, implementation plan, and test strategy — each with confidence, evidence, and limitations. No code fixes. | -| 🎯 **Deterministic output** | Same inputs → identical outputs. Diff-friendly, reviewable. | -| 🧾 **Evidence & provenance** | Every heuristic carries a confidence score and source evidence; artifacts include a content hash. | -| 🔒 **Read-only GitHub ingestion** | Reads an issue and repository signals; writes only local files. | -| 📄 **PRD artifact generation** | Repository-grounded PRD Markdown with explicit caveats. | -| 💻 **Single, honest CLI** | One `analyze` command, no hidden surface area. | -| 📴 **Offline-friendly** | `--from-file` runs with no network access. | -| 🛡️ **Untrusted-input handling** | Issue text is treated as data, never as instructions. | +| **Repository Intelligence Engine** | Builds a bounded `RepositoryContext` from issue + repository signals. | +| **Engineering diagnosis** | Deterministic root-cause hypotheses, solution strategy, implementation plan, and test strategy — each with confidence, evidence, and limitations. No code fixes. | +| **Deterministic output** | Same inputs → identical outputs. Diff-friendly, reviewable. | +| **Evidence & provenance** | Every heuristic carries a confidence score and source evidence; artifacts include a content hash. | +| **Read-only GitHub ingestion** | Reads an issue and repository signals; writes only local files. | +| **PRD artifact generation** | Repository-grounded PRD Markdown with explicit caveats. | +| **Single, honest CLI** | One `analyze` command, no hidden surface area. | +| **Offline-friendly** | `--from-file` runs with no network access. | +| **Untrusted-input handling** | Issue text is treated as data, never as instructions. | ## Installation diff --git a/assets/icons-3d/ai-scan.png b/assets/icons-3d/ai-scan.png new file mode 100644 index 0000000..47dd3fa Binary files /dev/null and b/assets/icons-3d/ai-scan.png differ diff --git a/assets/icons-3d/check.png b/assets/icons-3d/check.png new file mode 100644 index 0000000..d45a371 Binary files /dev/null and b/assets/icons-3d/check.png differ diff --git a/assets/icons-3d/cross.png b/assets/icons-3d/cross.png new file mode 100644 index 0000000..e3f63ba Binary files /dev/null and b/assets/icons-3d/cross.png differ diff --git a/assets/icons-3d/file-text.png b/assets/icons-3d/file-text.png new file mode 100644 index 0000000..6cc3ba1 Binary files /dev/null and b/assets/icons-3d/file-text.png differ diff --git a/assets/icons-3d/lock.png b/assets/icons-3d/lock.png new file mode 100644 index 0000000..b072828 Binary files /dev/null and b/assets/icons-3d/lock.png differ diff --git a/assets/icons-3d/search.png b/assets/icons-3d/search.png new file mode 100644 index 0000000..d188f55 Binary files /dev/null and b/assets/icons-3d/search.png differ diff --git a/assets/icons-3d/shield.png b/assets/icons-3d/shield.png new file mode 100644 index 0000000..e55d08e Binary files /dev/null and b/assets/icons-3d/shield.png differ diff --git a/assets/icons-3d/signal-off.png b/assets/icons-3d/signal-off.png new file mode 100644 index 0000000..9574f00 Binary files /dev/null and b/assets/icons-3d/signal-off.png differ diff --git a/assets/icons-3d/target.png b/assets/icons-3d/target.png new file mode 100644 index 0000000..e46910b Binary files /dev/null and b/assets/icons-3d/target.png differ diff --git a/assets/icons-3d/terminal.png b/assets/icons-3d/terminal.png new file mode 100644 index 0000000..faf1573 Binary files /dev/null and b/assets/icons-3d/terminal.png differ diff --git a/assets/icons-3d/warning.png b/assets/icons-3d/warning.png new file mode 100644 index 0000000..d24cce9 Binary files /dev/null and b/assets/icons-3d/warning.png differ diff --git a/assets/issue2dev-banner.png b/assets/issue2dev-banner.png new file mode 100644 index 0000000..049c940 Binary files /dev/null and b/assets/issue2dev-banner.png differ