From 42474dd7f062d924ab1944c15471cc13c89e96cd Mon Sep 17 00:00:00 2001 From: Tamer Date: Sun, 20 Sep 2026 20:47:20 +0200 Subject: [PATCH 1/3] docs: document contributor check prerequisites Signed-off-by: Tamer --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 96ce8f861..07a96ee97 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ Contributions are welcome. This guide covers setup, testing, and PR guidelines. ## Build from Source -**Prerequisites**: C compiler (gcc or clang), make, zlib, Git. Optional: Node.js 22+ (for graph UI). +**Build prerequisites**: C compiler (gcc or clang), make, zlib, Git. Optional: Node.js 22+ (for graph UI).\n\n**Contributor check prerequisites**: `scripts/test.sh` also requires `zip`, `python3`, and `curl`. `scripts/lint.sh` requires `cppcheck` and `clang-format`; full lint mode also requires `clang-tidy`. ```bash git clone https://github.com/DeusData/codebase-memory-mcp.git From 28d62001fd1e5d0a18085a8a662a1b806747815f Mon Sep 17 00:00:00 2001 From: Tamer Date: Sun, 20 Sep 2026 20:47:41 +0200 Subject: [PATCH 2/3] docs: clarify test and lint prerequisites Signed-off-by: Tamer --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 9d9e4ee09..9a74d8f4a 100644 --- a/README.md +++ b/README.md @@ -415,6 +415,8 @@ You: "Install this MCP server: https://github.com/DeusData/codebase-memory-mcp" +> **Contributor checks need a few extra tools.** `scripts/test.sh` requires `zip`, `python3`, and `curl`. `scripts/lint.sh` requires `cppcheck` and `clang-format`; full lint mode also requires `clang-tidy`. + ```bash git clone https://github.com/DeusData/codebase-memory-mcp.git cd codebase-memory-mcp From 2a7da82a044c8ac49d09d9192775b25ba00d9f7b Mon Sep 17 00:00:00 2001 From: Martin Vogel Date: Tue, 20 Oct 2026 19:31:31 +0200 Subject: [PATCH 3/3] docs: fix contributor prerequisites paragraph break and lint wording Replace the literal "\n\n" in CONTRIBUTING.md with a real paragraph break; Markdown rendered it as text in the middle of the sentence. A plain scripts/lint.sh run is the full mode and needs clang-tidy as well as cppcheck and clang-format; scripts/lint.sh --ci, which is what CI runs, skips clang-tidy. Say it that way round in README.md and CONTRIBUTING.md. The curl entry stays: since 6c00f9631152 (#2480) Step 0y3 of scripts/test.sh runs the setup-script contract, which downloads a local fixture release through scripts/setup.sh with curl. Signed-off-by: Martin Vogel --- CONTRIBUTING.md | 4 +++- README.md | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 07a96ee97..a67bd460e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,9 @@ Contributions are welcome. This guide covers setup, testing, and PR guidelines. ## Build from Source -**Build prerequisites**: C compiler (gcc or clang), make, zlib, Git. Optional: Node.js 22+ (for graph UI).\n\n**Contributor check prerequisites**: `scripts/test.sh` also requires `zip`, `python3`, and `curl`. `scripts/lint.sh` requires `cppcheck` and `clang-format`; full lint mode also requires `clang-tidy`. +**Build prerequisites**: C compiler (gcc or clang), make, zlib, Git. Optional: Node.js 22+ (for graph UI). + +**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`. ```bash git clone https://github.com/DeusData/codebase-memory-mcp.git diff --git a/README.md b/README.md index 9a74d8f4a..f5a71b0a6 100644 --- a/README.md +++ b/README.md @@ -415,7 +415,7 @@ You: "Install this MCP server: https://github.com/DeusData/codebase-memory-mcp" -> **Contributor checks need a few extra tools.** `scripts/test.sh` requires `zip`, `python3`, and `curl`. `scripts/lint.sh` requires `cppcheck` and `clang-format`; full lint mode also requires `clang-tidy`. +> **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`. ```bash git clone https://github.com/DeusData/codebase-memory-mcp.git