What problem does it solve?
Provides a clear, consistent Git workflow and deployment checklist for the CYPHER V3 repository to reduce noisy commits, avoid merge conflicts, prevent broken builds in production, and ensure secrets are never committed.
Core Features & Use Cases
- Conventional Commits: Enforces structured commit messages (feat|fix|perf|security|etc.) scoped to repository modules for discoverability and changelog automation.
- Branching Strategy: Defines protected main and staging branches, feature/fix/hotfix branch patterns, and a PR-driven merge flow.
- Pre-commit & CI Checks: Recommends Husky hooks that run type checking and linting to block commits that would break builds or quality gates.
- Deploy Pipeline & Recovery: Details automatic Vercel production deploys from main, PR previews, optional Railway workflow, and Docker run instructions for local/staging testing.
- Checklist & Hygiene: Includes a pre-merge checklist to verify builds, audits, no hardcoded secrets, and conventional commit compliance.
Quick Start
Create a feature branch, run the pre-commit checks (type-check and lint), commit with a conventional message, push the branch, and open a pull request for review.