Skip to content

Commit 00efb39

Browse files
committed
docs: add marketplace readiness plan
1 parent 64cb4fe commit 00efb39

1 file changed

Lines changed: 79 additions & 0 deletions

File tree

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# CodeSensei Marketplace Readiness Implementation Plan
2+
3+
> For Hermes: execute this plan with frequent verification and atomic commits directly on `main`.
4+
5+
**Goal:** Make `DojoCodingLabs/code-sensei` ready for marketplace publication by fixing public-facing inconsistencies, hardening trust/privacy behavior, improving onboarding, and enforcing critical behavior in tests/CI.
6+
7+
**Architecture:** Keep the current lightweight plugin architecture (hooks + shell scripts + prompt commands + local JSON profile), but move launch-critical behavior toward clearer deterministic scripts and stronger guardrails. Prioritize user trust, clear onboarding, and reliable validation over adding net-new product scope.
8+
9+
**Tech Stack:** Claude Code plugin manifests, Bash hook scripts, jq-based JSON mutation, Markdown command prompts, GitHub Actions.
10+
11+
---
12+
13+
## Launch blockers to address
14+
15+
1. Public docs and metadata are inconsistent with the repo (command/concept/category counts, onboarding, privacy detail).
16+
2. Command logging can capture secrets or tokens; privacy copy is less precise than actual behavior.
17+
3. Import flow is prompt-only while export is scripted; setup verification is weak.
18+
4. Hook regression test fails and CI does not run it.
19+
5. Marketplace assets/copy need tightening to feel polished and reviewer-friendly.
20+
21+
---
22+
23+
## Planned workstreams
24+
25+
### Workstream 1 — Planning and launch checklist
26+
- Add this plan to the repo so launch work is documented and reviewable.
27+
- Keep commits atomic and grouped by theme.
28+
29+
### Workstream 2 — Marketplace-facing docs and metadata
30+
- Update `README.md` to match reality:
31+
- correct command count
32+
- correct concept/category counts
33+
- clearer first-run steps
34+
- explicit jq requirement
35+
- precise privacy/storage section
36+
- setup/doctor guidance
37+
- Update `CONTRIBUTING.md` to reflect current command set and validation expectations.
38+
- Tighten `.claude-plugin/plugin.json` and `.claude-plugin/marketplace.json` copy for clearer marketplace positioning.
39+
- Add any missing support/launch docs that materially improve marketplace trust.
40+
41+
### Workstream 3 — Runtime trust and onboarding hardening
42+
- Add deterministic setup verification via a new doctor/setup command and supporting script.
43+
- Implement a real import script so import/export are symmetrical and less prompt-dependent.
44+
- Add secret-safe command logging/redaction to `scripts/track-command.sh`.
45+
- Review local storage/retention behavior and document it precisely.
46+
47+
### Workstream 4 — Behavior reliability and tests
48+
- Reproduce and root-cause the failing `tests/test-hooks.sh` case.
49+
- Fix the behavior or the test expectation based on intended rate-limit semantics.
50+
- Expand tests to cover new doctor/import/redaction behavior where practical.
51+
- Update `.github/workflows/validate.yml` to run hook regression tests in CI.
52+
53+
### Workstream 5 — Final verification and publish
54+
- Run full local validation for shell scripts, JSON, and hook tests.
55+
- Review `git diff` for launch quality.
56+
- Push all atomic commits to `main`.
57+
58+
---
59+
60+
## Atomic commit plan
61+
62+
1. `docs: add marketplace readiness plan`
63+
2. `docs: polish marketplace copy and onboarding`
64+
3. `feat: add doctor and import scripts`
65+
4. `fix: redact sensitive command logging`
66+
5. `test: fix hook regression coverage and enforce in ci`
67+
6. `chore: final marketplace readiness touchups` (only if genuinely needed)
68+
69+
---
70+
71+
## Verification checklist
72+
73+
- [ ] README/metadata match actual repo contents
74+
- [ ] Import is backed by a script, not only prompt instructions
75+
- [ ] Setup/doctor experience exists and is documented
76+
- [ ] Sensitive command patterns are redacted before logging
77+
- [ ] Hook regression tests pass locally
78+
- [ ] CI runs critical hook tests
79+
- [ ] Repo is clean and pushed to `main`

0 commit comments

Comments
 (0)