// Use when committing and pushing code changes, ensures DCO compliance and pre-commit validation
Use when building knowhere from source, configuring build options (CPU/GPU/DISKANN/ASAN), or troubleshooting compilation errors
Use when exploring codebase structure, understanding index implementations (HNSW, IVF, DISKANN, Sparse, MinHash), working with third-party libraries (faiss, hnswlib, DiskANN, Cardinal), or locating specific functionality
Use when checking code style, running pre-commit hooks, or before committing changes to ensure compliance with Google style guide
Use when running unit tests, debugging test failures, or adding new test cases using Catch2 framework
| name | git-workflow |
| description | Use when committing and pushing code changes, ensures DCO compliance and pre-commit validation |
Always run pre-commit validation:
# Validate specific files
pre-commit run --files <changed-files>
# Or validate all staged files
pre-commit run
Fix any issues before proceeding.
All commits must include a Signed-off-by line for DCO compliance:
git commit -s -m "commit message"
Or add manually:
Signed-off-by: Your Name <your.email@example.com>
Stage changes
git add <files>
Run pre-commit
pre-commit run
Fix any issues and re-stage if needed
Commit with DCO sign-off
git commit -s -m "type: description"
type: short description
Optional longer description.
Signed-off-by: Name <email>
Types: feat, fix, docs, refactor, test, chore
git push origin <branch>
| Task | Command |
|---|---|
| Pre-commit check | pre-commit run |
| Commit with DCO | git commit -s -m "message" |
| Amend with DCO | git commit --amend -s |
| Push | git push origin <branch> |