Skip to content

Commit a5b248f

Browse files
authored
Merge pull request DeusData#2261 from tamerbak/docs/contributor-check-prerequisites
Docs/contributor check prerequisites
2 parents 9f278b7 + 384e730 commit a5b248f

2 files changed

Lines changed: 5 additions & 1 deletion

File tree

‎CONTRIBUTING.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ Contributions are welcome. This guide covers setup, testing, and PR guidelines.
66
77
## Build from Source
88

9-
**Prerequisites**: C compiler (gcc or clang), make, zlib, Git. Optional: Node.js 22+ (for graph UI).
9+
**Build prerequisites**: C compiler (gcc or clang), make, zlib, Git. Optional: Node.js 22+ (for graph UI).
10+
11+
**Contributor check prerequisites**: `scripts/test.sh` also requires `zip`, `python3`, and `curl`. `scripts/lint.sh` requires `cppcheck`, `clang-format`, and `clang-tidy`; `scripts/lint.sh --ci`, which is what CI runs, skips `clang-tidy`.
1012

1113
```bash
1214
git clone https://github.com/DeusData/codebase-memory-mcp.git

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -617,6 +617,8 @@ running an installer.
617617

618618
</details>
619619

620+
> **Contributor checks need a few extra tools.** `scripts/test.sh` requires `zip`, `python3`, and `curl`. `scripts/lint.sh` requires `cppcheck`, `clang-format`, and `clang-tidy`; `scripts/lint.sh --ci`, which is what CI runs, skips `clang-tidy`.
621+
620622
```bash
621623
git clone https://github.com/DeusData/codebase-memory-mcp.git
622624
cd codebase-memory-mcp

0 commit comments

Comments
 (0)