You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: add Contributing section to README (local dev setup, FTS5 workaround) #305
There are no contributing or local development instructions in the project. The README only covers end-user installation. A first-time contributor has no guidance on:
How to fork and set up the project locally
How to wire the codegraph CLI command to their local build instead of the published package
How to run the test suite
The no such module: fts5 error that blocks indexing when running from source on Node 22/23 macOS
Proposed solution
Add a Contributing section to the README covering:
Fork + clone + add upstream remote
npm install + npm run build
npm link to point the global codegraph command at your local build (and how to restore the published version)
Development workflow (npm run dev, npm test, npm run test:watch)
FTS5 workaround — Node 22 and 23 on macOS ship without FTS5; switch to Node 24 via nvm
A quick verification snippet to confirm FTS5 is available before indexing
FTS5 is missing from the official Node 22.x and 23.x macOS binaries. Node 24+ includes it. The self-contained bundled release (curl install / npm i -g) ships its own Node binary that has FTS5, so end users are unaffected — this only hits contributors running from source.
npm run cli is an alternative to npm link for running the local build without touching the global symlink.
Done in #3081: CONTRIBUTING.md now covers local development setup and testing, and the README links to it. The FTS5 workaround is no longer needed, because CodeGraph has run without it since #1532. Closing this.
Activity
[-]Contributing[/-][+]docs: add Contributing section to README (local dev setup, FTS5 workaround)[/+]docs: add Contributing section to README
marcelovani commentedon May 22, 2026
#306 is ready for review
colbymchenry commentedon Oct 30, 2026
Done in #3081: CONTRIBUTING.md now covers local development setup and testing, and the README links to it. The FTS5 workaround is no longer needed, because CodeGraph has run without it since #1532. Closing this.