Contributing
How to contribute to Bookmark Scout
Contributing
Contributions are welcome!
Setup
gh repo fork isandrel/bookmark-scout --clone
cd bookmark-scout
bun install
bun run devThe repository is a Bun + Nx monorepo with three apps:
apps/extension— WXT browser extension for Chrome, Firefox, and Edgeapps/website— localized Next.js marketing siteapps/docs— Fumadocs documentation site
Pull Request
git checkout -b feat/your-feature
git add .
git commit -m "feat: add feature"
git push origin feat/your-feature
gh pr createCommit Convention
| Type | Description |
|---|---|
feat | New feature |
fix | Bug fix |
docs | Documentation |
refactor | Code refactoring |
test | Tests |
chore | Maintenance |
Verification
Run the smallest relevant command set for your change:
| Area | Command |
|---|---|
| Extension source | bunx nx run extension:lint |
| Extension runtime, manifest, provider, or browser integration | bunx nx run extension:build:chrome plus any affected browser target |
| Website | bunx nx run website:build |
| Docs | bunx nx run docs:build |
| Cross-app changes | bun run lint and bun run build:all |
There is no dedicated automated unit or integration test suite exposed through the normal workspace scripts yet. Do not treat lint or build success as test coverage.
Localization
When changing user-facing extension copy, update all extension locale files:
apps/extension/public/_locales/en/messages.jsonapps/extension/public/_locales/ja/messages.jsonapps/extension/public/_locales/ko/messages.json
When changing localized website copy, update all website message files:
apps/website/messages/en.jsonapps/website/messages/ja.jsonapps/website/messages/ko.json