Skip to content

Docs/contributor check prerequisites #2261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DeusData merged 7 commits into from
Nov 1, 2026
Merged

Docs/contributor check prerequisites #2261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
42474dd
docs: document contributor check prerequisites
tamerbak Sep 20, 2026
28d6200
docs: clarify test and lint prerequisites
tamerbak Sep 20, 2026
2a7da82
docs: fix contributor prerequisites paragraph break and lint wording
DeusData Oct 20, 2026
8c1fc27
Merge branch 'main' into docs/contributor-check-prerequisites
DeusData Oct 20, 2026
7153cc9
Merge origin/main into docs/contributor-check-prerequisites
DeusData Oct 25, 2026
86136c4
Merge origin/main into docs/contributor-check-prerequisites
DeusData Oct 27, 2026
384e730
Merge origin/main into docs/contributor-check-prerequisites
DeusData Nov 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ 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).

**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
Expand Down
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -617,6 +617,8 @@ running an installer.

</details>

> **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
cd codebase-memory-mcp
Expand Down
Loading