Skip to content

docs: add Contributing section to README - #306

Closed
marcelovani wants to merge 1 commit into
colbymchenry:mainfrom
marcelovani:docs/contributing-guide
Closed

marcelovani wants to merge 1 commit into
colbymchenry:mainfrom
marcelovani:docs/contributing-guide

Conversation

@marcelovani

@marcelovani marcelovani commented May 22, 2026 •

Copy link
Copy Markdown
Contributor

Closes #305

Summary

  • Adds a Contributing section to the README with end-to-end setup instructions for new contributors
  • Covers fork/clone, npm install + npm run build, and how to wire the global codegraph command to your local build via npm link (or bypass it with npm run cli)
  • Documents the FTS5 workaround: Node 22 and 23 on macOS ship without FTS5; switch to Node 24 via nvm
  • Includes a quick FTS5 verification snippet and a PR checklist

Test plan

  • README renders correctly on GitHub
  • All commands verified against the local environment

Covers fork/clone, build, npm link vs npm run cli, dev workflow,
FTS5 workaround for Node 22/23 on macOS, and PR checklist.
Closes colbymchenry#305
@colbymchenry

Copy link
Copy Markdown
Owner

Thanks, @marcelovani! The fork setup, local-run command and PR checklist from this PR are now in CONTRIBUTING.md via #3081, with credit, so I'm closing this one. The FTS5 workaround is no longer needed, because CodeGraph has run without it since #1532.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add Contributing section to README (local dev setup, FTS5 workaround)

2 participants