A shared playbook for vibe coding — a single home for the writing styleguides, planning systems, and lint/project setups I keep re-deriving in every new project.
The goal is simple: instead of rebuilding quality bars, planning workflows, and writing conventions from scratch each time, they live here as portable templates and configs. Point a human — or an AI agent — at this repo to bootstrap a new project consistently.
This repo is being built out as a set of focused areas. Each area is tracked by an issue so the work and the rationale stay visible.
| Area | Location | Status / Tracking |
|---|---|---|
| Writing styleguide | docs/writing/styleguide.md |
Available — see #2 |
| Planning system (language-parameterized) | planning/templates/{language}/ |
Available — see #3 |
| Project setup (lint/complexity/configs) | project-setup/{language}/ |
Available — see #4 |
| Bun & Deno templates | project-setup/{bun,deno}/ |
Available — see #9 |
| Review configs (OCR + CodeRabbit) | review-configs/ |
Available — see #10 |
| CI quality gates | ci-gates/{language}/ |
Available — see #11 |
| Agent skills | skills/ |
Available — see #15 |
Existing reference notes in docs/ (TYPESCRIPT_STANDARDS.md, TESTING_GUIDE.md,
MOCKING_STRATEGY.md) are retained as source material and will be folded into the
language-specific setups above as that work lands.
Once the areas above are in place, bootstrapping a new project is meant to be a two-step pattern you can hand to an agent:
- Plan the work — copy the planning docs from
planning/templates/<language>/into the new repo and follow them. - Set the quality bar — install the matching lint/complexity config from
project-setup/<language>/(a setup script fills in project-specific names).
Each area has its own README with exact usage once it's built out.
A general-purpose writing styleguide lives at docs/writing/styleguide.md.
It was coalesced from project-specific styleguides and stripped of all domain,
client, and publication specifics so it applies to any non-fiction prose project.
Point a writer or agent at this file as the canonical writing styleguide.
A portable, language-parameterized planning system lives at
planning/templates/. It was distilled from a mature
multi-phase TDD planning system and de-repo-ified so it works for any project.
How it's organized:
planning/templates/_base/— language-agnostic docs shared by every language:PLAN.md— the methodology (phases, TDD, integration, fraud detection, verification gates).PLAN-TEMPLATE.md— fill-in-the-blanks structure for generating concrete plans.COORDINATING.md— rules for executing a plan one phase at a time with isolated subagents.
planning/templates/{rust,typescript,python}/RULES.md— language-specific development rules (typing, testing, mocks, verification).
To use it: copy the three _base/ docs plus the RULES.md for your language
into your project, then point an agent at PLAN.md and COORDINATING.md. See
planning/templates/README.md for full details.
Note: this README describes the intended end state. The sections above are filled in as their tracking issues (#2, #3, #4) land. Anything that used to live here (
o3helper.js,workers.md, the oldPLAN.md, andexecutor/) has been removed as obsolete — see #1.
Canonical, language-specific lint / complexity / formatting / type-check
configs live at project-setup/. They were coalesced from
several production projects and set to the strictest value wherever sources
disagreed.
How it's organized:
project-setup/rust/— clippy + rustfmt + Cargo lint policy, merged from jefe, luther, and personal-agent (strictest of each).project-setup/typescript/— ESLint flat config, tsconfig, Prettier, distilled from a mature production codebase (Node 24+).project-setup/bun/— Biome (replaces ESLint+Prettier), bunfig.toml, tsconfig for Bun. Single-toolchain, 10-50x faster.project-setup/deno/— Deno built-in lint/fmt/check/test. Zero external dependencies — everything ships with the Deno runtime.project-setup/python/— ruff + mypy + pytest + coverage config, distilled from a production Python codebase.
Each language has an init.sh installer, and a universal launcher ties them
together. To set up linting/complexity for a new project, run:
project-setup/setup.sh <language> . # rust | typescript | bun | deno | pythonSee project-setup/README.md for full details,
including the rule-by-rule rationale for how conflicts were resolved.
Portable templates for automated code review tools live at
review-configs/. Both enforce the same senior-engineer
rubric (correctness → contract → edge cases → type safety → security →
maintainability) and the same lint-guardrail policy (no suppression directives,
no severity downgrades, no threshold increases).
What's included:
review-configs/ocr/— OpenCodeReview templates: review rubric (rule.json), language-specific test includes, fork-safe language-configurable CI workflow (ocr-review.yml), plan-review prompt, and an agent command definition.review-configs/coderabbit/— CodeRabbit.coderabbit.yamltemplate with assertive profile and lint-guardrail enforcement.
Quick start:
# OCR: install the global rule + add the CI workflow
mkdir -p ~/.opencodereview
cp review-configs/ocr/rule.json ~/.opencodereview/rule.json
cp review-configs/ocr/ocr-review.yml your-project/.github/workflows/ocr-review.yml
# CodeRabbit: drop in the config
cp review-configs/coderabbit/.coderabbit.yaml your-project/.coderabbit.yamlSee review-configs/README.md for full details.
Radically simplified, language-specific GitHub Actions CI workflows live at
ci-gates/. Each is a single sequential job — lint → format
check → typecheck → test (with coverage) → build — with concurrency control
and caching. All are 40–47 lines, stripped from 400+ line source workflows.
What's included:
| Language | Steps |
|---|---|
ci-gates/typescript/ |
ESLint (--max-warnings 0), Prettier check, tsc, Vitest --coverage, build |
ci-gates/rust/ |
cargo fmt --check, clippy -D warnings, build --locked, test --locked |
ci-gates/python/ |
ruff check, ruff format --check, mypy --strict, pytest --coverage |
ci-gates/bun/ |
Biome check, tsc --noEmit, bun test --coverage |
ci-gates/deno/ |
deno fmt --check, deno lint, deno check, deno test --coverage |
Quick start:
cp ci-gates/<language>/ci.yml your-project/.github/workflows/ci.ymlThe project-setup/<language>/init.sh scripts also optionally copy the CI
gate alongside the lint config — so a single setup.sh run bootstraps both.
See ci-gates/README.md for full details.
Portable agent skills (LLxprt Code / Gemini CLI SKILL.md format) live at
skills/. Each skill codifies a review or quality workflow as an
activatable agent capability.
What's included:
skills/open-code-review/— runs OpenCodeReview (ocr) in the background, classifies findings by severity (High/Medium/Low), and applies fixes. Referencesreview-configs/ocr/as installation prerequisites.skills/coderabbit-review/— runs the CodeRabbit CLI locally with--agentstructured findings, classifies by severity, and supports autonomous implement-review-fix cycles. Referencesreview-configs/coderabbit/as the config source.
Quick start:
# Install all skills to the platform-specific user skills dir
skills/install.sh
# Or install to a specific project
skills/install.sh /path/to/projectSee skills/README.md for the skill format, discovery
paths, and installation details.
See LICENSE.