Build In Public

Build in Public

Overview

Use this skill when the project already works and the job is to make it presentable, safe, and usable in public. The workflow works for any local repo.

Resources

• references/public-release-checklist.md

Use for the public-release gate and the final completion pass.

• references/readme-template.md

Use when writing or restructuring README.md.

• scripts/create_release_zip.sh

Use to create a clean zip from the current HEAD after the repo is ready.

Optional Accelerators

When the host provides extra capabilities, use them as accelerators. Never make them hard dependencies; the workflow must complete with ordinary shell, git, and gh.

• Web search for current publish-platform facts, package behavior, or security

advisories. Prefer primary sources and cite them.

• Image generation for README visuals when a diagram or hero asset aids a cold

reader. Native image generation is a Codex feature; on other hosts, fall back to Mermaid, SVG, or repo-native diagrams for exact labels.

• In-app browser preview for local web previews and public-page review.
• Computer use for narrow GUI verification (desktop apps, simulators, documents).
• Worktrees, native Git review, and subagents for isolated or parallel

release-prep lanes, when the host makes them safe.

• Automations only for recurring release-health checks, never for one-off

publishing decisions.

Default Outcome

By the end of this skill, the repo should have:

• a README that clearly explains the problem, why it was built, what it does, and how to use it
• an optional project-bound diagram or visual asset when it materially improves cold-reader orientation
• a clean public-facing description and suggested GitHub topics
• basic hardening for setup, errors, ignored files, and user-facing defaults
• tests or smoke checks that prove the main path and at least one edge or failure case
• a license and example configuration where needed
• a clean zip artifact created from committed code
• either a public GitHub repo on the user's personal profile or an exact blocker explaining why publish should wait

Release Strategy

Pick the safer lane before editing:

1. Reuse the existing repo when its git history, file set, and naming are already safe to expose.
2. Create a clean public-export repo when the working project is good but the existing repo has scratch history, private notes, experimental debris, or secrets in history.

Rules:

• For sandbox projects, prefer a sibling public repo (e.g. /-public) when public history is questionable.
• Preserve provenance in a short note, but do not leak private paths, internal project names, or personal machine details.
• If history rewriting would be needed to make the current repo safe, prefer a fresh public export unless the user explicitly wants history preserved.
• Do not publish anything until the repo is understandable to a stranger from a cold clone.

Workflow

1. Preflight

1. Inspect the target repo, remotes, git status, build system, test commands, and every AGENTS.md in scope.
2. Read references/public-release-checklist.md.
3. Read references/readme-template.md if the README needs to be created or rewritten.
4. Determine whether to harden in place or create a clean public-export repo.
5. Derive the likely public name, one-line description, install flow, and target audience from the repo itself. Ask only if those are truly ambiguous.
6. Default the publish destination to the user's personal GitHub with public visibility when the request is to build in public.
7. Check which optional accelerators are available in the current environment, then choose the lightest useful path: local shell for deterministic repo work, web search for current external facts, browser/computer use for UI verification, image generation for helpful visuals, and worktrees/subagents only when they improve throughput safely.
8. Ask for the spark. Before writing anything, read the code deeply enough to form three plausible hypotheses about why this was built. Then ask the user — present your three best guesses as options, plus a free-text field for something else entirely:

> What was the moment that made you build this? > 1. [Your first hypothesis, drawn from the code] > 2. [Your second hypothesis] > 3. [Your third hypothesis] > 4. Something else — tell me in your own words

See [references/narrative-voice.md](references/narrative-voice.md) for the three-options pattern and how to weigh the user's answer against the code.

2. Audit Public Risk

Inspect the repo for anything that should not go public:

• secrets, .env files, tokens, API keys, private credentials, or copied shell history
• internal URLs, personal emails, absolute local paths, machine-specific instructions, or private screenshots
• private datasets, vendor assets, or sample files that cannot be redistributed
• caches, logs, generated databases, debug output, and local-only artifacts
• scratch commit history that tells the wrong story or exposes private context

Guidance:

• Use fast local inspection first: rg, git status, git log, git ls-files, and targeted file reads.
• If the risk is in the working tree, clean it up.
• If the risk is only in history, prefer a clean export repo instead of risky history surgery.

3. Harden The Repo

Do the smallest credible pass that makes the project usable by other people:

• make install and run steps deterministic
• add or tighten env.example, sample config, and ignore rules where needed
• improve the primary entrypoint so errors are readable and defaults are sensible
• remove dead experimental clutter that confuses first-time users
• add or improve tests so the main path is covered plus at least one failure or edge case
• match proof to product shape:
• CLIs: command help plus a real command smoke test
• libraries: unit tests around the public API
• web apps: browser or request-level smoke on the main flow
• APIs/services: request-response proof plus error handling checks
• add lightweight CI only when the repo already has a straightforward command worth automating
• default the license to MIT unless the repo or user clearly points somewhere else

Do not turn this into a large rewrite. "Public-ready" means polished enough to be honestly shared, not rebuilt from scratch.

4. Write Public Docs

Create or rewrite the public-facing docs so a stranger can orient quickly:

• use references/readme-template.md for the README structure
• explain the problem first, then why this repo exists, then how to run it
• include one concrete quick-start path that works from a fresh clone
• document the test command and any required local dependencies
• be explicit about current limitations, platform assumptions, or rough edges
• include a short build-in-public note that explains the project's origin without oversharing internal context
• include a visual repo map or architecture diagram when it helps a cold reader understand the file layout, data flow, or user workflow. Prefer Mermaid or repo-native diagrams for exact labels; use image generation for polished illustrations, banners, or supporting visuals when available.
• prepare:
• a one-line GitHub description
• a short topic list
• optional release notes if the user wants an initial release

Generate the ASCII banner. Every README gets a figlet banner at the very top, above everything else. Use the rectangles font — no slanted characters. Run:

figlet -f rectangles -w 200 ""

Banner text rules:

• Use the project's display name, not its repo slug
• Replace any hyphens with spaces (build-in-public → build in public)
• Keep everything lowercase (Mock Pop → mock pop)
• If the display name differs from the repo slug (e.g. repo superwhisperer-lab, display superwhisper lab), use the display name

Wrap the output in a fenced code block. If figlet is not installed: brew install figlet. This is the first thing someone sees — it signals that the project has a real identity.

README visuals are committed artifacts. When a generated image belongs in the README, store it under assets/, reference it with a relative path and real alt text, and commit it with the README change. Full mechanics: [references/narrative-voice.md](references/narrative-voice.md) ("README Visuals").

Build the narrative from the code. The user's spark answer is context; the code is the source. Find what is genuinely interesting, frame the problem at the right specificity, and write to the anti-slop standard. Voice and tone: [references/narrative-voice.md](references/narrative-voice.md).

Structure follows the template. Use the canonical section skeleton and formatting toolkit in [references/readme-template.md](references/readme-template.md): badge row, fixed section order, callouts (max two), file-map table, collapsibles, structured lists, and a before→after example block for prose repos.

Avoid documentation sprawl. A strong README, a license, and the minimum supporting files beat a pile of ceremonial docs.

5. Verify And Package

Run the strongest verification the repo can reasonably support:

1. Run the relevant install, build, lint, test, and smoke commands.
2. Verify the quick-start instructions against the actual code.
3. If practical, simulate a cold-clone path instead of trusting the current machine state.
4. For web or visual surfaces, use the in-app browser when available and capture the verification result in the report.
5. For GUI-only surfaces, use computer use narrowly and record what was checked.
6. Create the public zip artifact from committed code:

bash "$(dirname "$0")/scripts/create_release_zip.sh" 
# Or from an installed skill:
#   bash ~/.claude/skills/build-in-public/scripts/create_release_zip.sh    # Claude Code
#   bash ~/.codex/skills/build-in-public/scripts/create_release_zip.sh     # Codex

The helper writes the zip under /tmp/build-in-public// by default. On a Codex host where ~/.codex/workspaces/ exists, it uses that path instead.

6. Publish

If the repo should be published now:

• use the hardened repo directly when it is safe
• otherwise create a clean export repo with only the intended public files and a fresh git history
• configure the GitHub remote on the user's personal account
• create the public GitHub repo with the prepared description
• push the default branch
• add topics and release metadata when the user asked for them or when they are clearly helpful

Typical CLI path:

gh repo create  --public --source . --remote origin --push --description ""
gh repo edit  --add-topic  --add-topic 
git tag v1.0.0 && git push origin v1.0.0
gh release create v1.0.0 --title "v1.0.0" --notes "Initial public release."

If the user only wants the repo prepared but not yet published, stop after packaging and report what remains.

7. Report

Summarize:

• the repo path that was prepared
• whether the work stayed in place or moved to a clean public-export repo
• the public description and topics
• the tests and verification that passed
• the zip artifact path
• the GitHub URL, or the exact blocker if publishing was intentionally deferred

Guardrails

• Do not push a repo public with tracked secrets, internal docs, proprietary data, or machine-specific junk.
• Do not assume exploratory git history is safe to expose.
• Do not silently publish from a dirty mixed worktree.
• Do not ship a README that hides meaningful limitations.
• Do not add a pile of extra docs just to look mature.
• Prefer a clean public-export repo over destructive history rewriting.
• Keep the hardening pass practical. The goal is a credible first public release, not a months-long polish cycle.

Quick Triggers

Use this skill when the user says things like:

• "build this in public"
• "make this lab repo public-ready"
• "turn this prototype into a public GitHub repo"
• "package this up so other people can download and use it"
• "do the final polish so I can open-source this"

Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

• Author: davidvictor
• Source: davidvictor/build-in-public
• License: MIT

Install and usage instructions live in the source repository linked above.