From dfbdc1ae0eacd6765ef37a040f2e13125faf1a3b Mon Sep 17 00:00:00 2001 From: wehub-resource-sync Date: Mon, 13 Jul 2026 10:23:43 +0000 Subject: [PATCH] docs: preserve upstream English README --- README.en.md | 147 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 147 insertions(+) create mode 100644 README.en.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..363476c --- /dev/null +++ b/README.en.md @@ -0,0 +1,147 @@ +

git push no-mistakes

+

+ Release + Platform + X + Discord +

+ +

+ kunchenguid%2Fno-mistakes | Trendshift +

+ +

Kill all the slop. Raise clean PR.

+ +

English · 简体中文

+ +

+ no-mistakes demo +

+ +`no-mistakes` puts a local git proxy in front of your real remote. +Push to `no-mistakes` instead of `origin`, and it spins up a disposable worktree, runs an AI-driven validation pipeline, forwards the branch to the configured push target only after every check passes, and opens a clean PR automatically. + +- **Non-blocking** - the pipeline runs in an isolated worktree without disrupting your work. +- **Agent-agnostic** - `claude`, `codex`, `rovodev`, `opencode`, `pi`, `copilot`, or `acp:` via `acpx`, with ordered fallbacks; every gate requires a runnable configured pipeline agent. +- **Agent-native** - `/no-mistakes` lets your coding agent do a task and gate it, or gate existing committed work: it runs the pipeline, has the pipeline apply safe fixes, and escalates the rest to you. +- **Human stays in charge** - auto-fix or review findings, your call. +- **Clean PRs by default** - push, open PR, watch CI, and auto-fix failures in one shot. + +Full documentation: + +## How it works + +``` + your branch + │ git push no-mistakes + ▼ + ┌────────────────────────────────────────────────┐ + │ disposable worktree — your work stays put │ + │ review → test → docs → lint → push → PR → CI │ + └────────────────────────────────────────────────┘ + │ every check green + ▼ + clean PR, opened for you +``` + +Each step either passes on its own or stops with a **finding** for you to act on. +Safe, mechanical fixes are applied automatically; anything that touches your intent is escalated for you to **approve**, **fix**, or **skip**. +Nothing reaches the configured push target until every check is green. + +## Install + +```sh +curl -fsSL https://raw.githubusercontent.com/kunchenguid/no-mistakes/main/docs/install.sh | sh +``` + +Windows, Go install, and build-from-source instructions are in the [installation guide](https://kunchenguid.github.io/no-mistakes/start-here/installation/). + +## Quick Start + +```sh +$ no-mistakes init + ✓ Gate initialized + + repo /Users/you/src/my-repo + gate no-mistakes → /Users/you/.no-mistakes/repos/abc123def456.git + remote git@github.com:you/my-repo.git + skill /no-mistakes installed for agents at user level + + Push through the gate with: + git push no-mistakes + +$ git checkout my-branch + +# do some work in the branch... + +$ git push no-mistakes + * Pipeline started + + Run no-mistakes to review. + +$ no-mistakes +# opens the TUI for the active run +``` + +For GitHub fork contributions, keep `origin` pointed at the parent repository and initialize with `no-mistakes init --fork-url `. + +From the TUI you act on each **finding**: **auto-fix** ones are applied for you (or approve to let them), **ask-user** ones are a judgement call you approve, fix, or skip. +Once every check is green, the gate forwards your branch to the configured push target and opens the PR for you, so there is no manual `git push origin` and no hand-written PR body. +Prefer to let your coding agent drive the same flow headlessly? +Use `/no-mistakes` (see below). + +## Three ways to trigger the gate + +Every change runs through the same pipeline. Pick the entry point that fits how you're working when the change is ready: + +- **`git push no-mistakes`** - the explicit Git path. Push a committed branch to the gate remote instead of `origin`. +- **`no-mistakes`** - the TUI. Run it after making changes (no commit needed) and a wizard walks you through creating a branch, committing, and pushing through the gate, then attaches to the run. `no-mistakes -y` does all of that automatically. +- **`/no-mistakes`** - the agent skill. Tell the coding agent to do a task and gate it with `/no-mistakes `, or use bare `/no-mistakes` to gate existing committed work. It runs the pipeline, has the pipeline apply safe fixes, and stops to ask you about anything that needs a human call. + +`no-mistakes init` installs the `/no-mistakes` skill for Claude Code and other agents. Under the hood the skill drives `no-mistakes axi`, a non-interactive TOON interface to the same approval flow. + +See the [quick start](https://kunchenguid.github.io/no-mistakes/start-here/quick-start/) for the full first-run walkthrough. + +## Development + +```sh +make build # Build bin/no-mistakes with version info +make test # Run go test -race ./... (excludes the e2e suite) +make e2e # Run the tagged end-to-end agent journey suite +make e2e-record # Re-record e2e fixtures when agent wire formats change +make lint # Check generated skill drift and run go vet ./... +make skill # Regenerate committed no-mistakes skill files +make fmt # Run gofmt -w . +make demo # Regenerate demo.gif and demo.mp4 (needs vhs and ffmpeg) +make docs # Build the Astro docs site in docs/dist +``` + +See `Makefile` for the full target list. + +`make e2e-record` overwrites `internal/e2e/fixtures/` from the real `claude`, `codex`, and `opencode` CLIs, spends real API quota, and should be reviewed before committing. + +## Star History + + + + + + Star History Chart + +