Skip to content

Commit 2a7da82

Browse files
committed
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 6c00f96 (DeusData#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 <martin.vogel.tech@gmail.com>
1 parent 28d6200 commit 2a7da82

2 files changed

Lines changed: 4 additions & 2 deletions

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-
**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`.
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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,7 @@ You: "Install this MCP server: https://github.com/DeusData/codebase-memory-mcp"
415415

416416
</details>
417417

418-
> **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`.
418+
> **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`.
419419
420420
```bash
421421
git clone https://github.com/DeusData/codebase-memory-mcp.git

0 commit comments

Comments
 (0)