From 1f9dc60da4c1598f991fb4e605c8ff79cbe5414d Mon Sep 17 00:00:00 2001 From: ruv Date: Sun, 1 Mar 2026 11:30:03 -0500 Subject: [PATCH] docs: add Pre-Merge Checklist to CLAUDE.md Co-Authored-By: claude-flow --- CLAUDE.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CLAUDE.md b/CLAUDE.md index ad4b2fd..9e545b5 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -89,6 +89,19 @@ All development on: `claude/validate-code-quality-WNrNw` - **HNSW**: Enabled - **Neural**: Enabled +## Pre-Merge Checklist + +Before merging any PR, verify each item applies and is addressed: + +1. **Tests pass** — `cargo test` (Rust) and `python -m pytest` (Python) green +2. **README.md** — Update platform tables, crate descriptions, hardware tables, feature summaries if scope changed +3. **CHANGELOG.md** — Add entry under `[Unreleased]` with what was added/fixed/changed +4. **User guide** (`docs/user-guide.md`) — Update if new data sources, CLI flags, or setup steps were added +5. **ADR index** — Update ADR count in README docs table if a new ADR was created +6. **Docker Hub image** — Only rebuild if Dockerfile, dependencies, or runtime behavior changed (not needed for platform-gated code that doesn't affect the Linux container) +7. **Crate publishing** — Only needed if a crate is published to crates.io and its public API changed (workspace-internal crates don't need publishing) +8. **`.gitignore`** — Add any new build artifacts or binaries + ## Build & Test ```bash