docs: go-public README rewrite + CONTRIBUTING + publishing/npm story (#87) - #189
Merged
Merged
Conversation
Rewrite the root README for a stranger who has never seen the project: what reCode is, the actual supported quickstart (plugin install -> /orchestrator:setup -> arm the loop, verified against docs/GETTING_STARTED.md and .claude-plugin/plugin.json's real command names), and a cockpit serve-mode section with an explicit pending-screenshot placeholder marker instead of a fabricated image link. Add CONTRIBUTING.md documenting the self-hosted contribution model: the backlog -> planned two-label approval workflow, the scope -> build -> gate -> review -> PR -> merge pipeline, and what external contributors should not touch (.claude/self/, MANAGED template files, LICENSE, module boundaries). Record the npm-name situation (squatted-dead, scope vs. dispute undecided) in README's new Installing/publishing section so the open decision is written down where a contributor can find it. Hygiene: spot-checked (grep for /home/rcano paths and token patterns in tracked files, .gitignore coverage of .claude/state/, settings.local.json, .env*, editor dirs) and confirmed clean, consistent with the bot's prior 2026-07-23 sweep. No .gitignore changes needed.
Collaborator
Author
|
docs: go-public README rewrite + CONTRIBUTING + publishing/npm story (#87) (not yet reviewed) |
robercano
approved these changes
Jul 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Go-public docs pass for issue #87. Makes the repo readable to a stranger before it flips public.
/orchestrator:setup→arm-loop.sh), a cockpit serve-mode section, an "Installing / publishing" section documenting the supported plugin-marketplace install path and recording the npm-name situation (squatted-dead; scope-vs-dispute, decision pending).backlog→ owner-onlyplannedtwo-label workflow, the scope → build → gate → reviewer-lens (correctness + tests, consensus all) → bot-PR pipeline, and an explicit "what NOT to touch" list (.claude/self/,@orchestrator-managedMANAGED templates,LICENSE, module boundaries).Scope notes
a0a4f9a(MIT) — untouched here.<!-- TODO(#87) -->placeholder — no agent can capture a screen recording; the section describes the demo and the launch command in words rather than fabricating an image link./home/rcano+ token patterns; confirm.gitignorecovers.claude/state/,settings.local.json, editor dirs,.env*) found no new gap, so.gitignoreis unchanged.Validation
GATES_FILE=.claude/self/gates.json): build / lint / test all green (test includessmoke-fanout.shend-to-end).all. Command names, doc paths, and relative links verified real againstdocs/,.claude/commands/,plugin.json, andpackage.json.Closes #87
🤖 Generated with Claude Code