Contributing to Calipers
All contributions are welcome — code, documentation, bug reports, feature requests, and design feedback.
Dev environment
git clone https://github.com/heysolomon/calipers.git
cd calipers
pnpm install
pnpm dev --filter=@calipers/extension
Load apps/extension/dist/ as an unpacked extension in Chrome. The dev server rebuilds on save.
To run the companion website locally:
pnpm dev --filter=@calipers/web
Project structure
apps/extension/— Chrome/Firefox extension (Vite + TypeScript)
- src/background/ — Service worker - src/content/ — Content script, canvas overlay, and modes - src/popup/ — Extension popup UI
apps/web/— Companion website (Next.js)packages/shared/— Types and messages shared between extension and web
Before opening a PR
- Create a branch:
feat/your-featureorfix/your-bug - Run
pnpm typecheck && pnpm lint - Open a pull request against
main
See CONTRIBUTING.md for commit format, branch naming, and the full PR process.
Good first issues
Look for issues labelled good first issue on GitHub.