Handbook
Welcome to the Shipcheck handbook. This is the complete guide to applying product standards to any repo.
What’s inside
Section titled “What’s inside”- Beginners — New to Shipcheck? Start here
- Getting Started — Install and apply Shipcheck in 30 minutes
- Ship Gate — The 35-item checklist that defines “done”
- Error Contract — Structured error shape and exit codes
- Reference — Templates, scorecard, and CLI commands
What is Shipcheck?
Section titled “What is Shipcheck?”“Done” used to mean the code works. That’s not enough. A product is code + safety + error handling + docs + identity + shipping hygiene. Shipcheck defines the bar with 31 hard-gate items (A-D) that block release and 4 soft-gate items (E) that define “whole” — 35 items total.
The gate says what must be true, not how to implement it. Applicability tags prevent checkbox shame on repos where items don’t apply.