Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 1f9dc60

Browse files
committed
docs: add Pre-Merge Checklist to CLAUDE.md
Co-Authored-By: claude-flow <[email protected]>
1 parent 342e5cf commit 1f9dc60

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,19 @@ All development on: `claude/validate-code-quality-WNrNw`
8989
- **HNSW**: Enabled
9090
- **Neural**: Enabled
9191

92+
## Pre-Merge Checklist
93+
94+
Before merging any PR, verify each item applies and is addressed:
95+
96+
1. **Tests pass**`cargo test` (Rust) and `python -m pytest` (Python) green
97+
2. **README.md** — Update platform tables, crate descriptions, hardware tables, feature summaries if scope changed
98+
3. **CHANGELOG.md** — Add entry under `[Unreleased]` with what was added/fixed/changed
99+
4. **User guide** (`docs/user-guide.md`) — Update if new data sources, CLI flags, or setup steps were added
100+
5. **ADR index** — Update ADR count in README docs table if a new ADR was created
101+
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)
102+
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)
103+
8. **`.gitignore`** — Add any new build artifacts or binaries
104+
92105
## Build & Test
93106

94107
```bash

0 commit comments

Comments
 (0)