CONTRIBUTING.md

Contributing

This guide is for developers contributing to this repository.

1. Development environment setup

• Use Bun 1.4.3 and Node.js 22.22.1.
• Install dependencies:

bun install

• For runtime checks, prepare .env as described in quick-start.md.

2. Local development and debugging

Run the CLI locally:

bun run dev

Use your local input directory and Algolia credentials through environment variables.

3. Build, lint, and test commands

• Build:

bun run build

• Lint:

bun run lint

• Lint with autofix:

bun run lint:fix

• Unit tests:

bun run test

4. Unit test policy

• Add or update tests for every behavior change.
• Keep tests deterministic and isolated.
• Run bun run test before pushing.
• Pre-push hook also runs tests. Do not bypass failures.

5. Workflow and pull requests

• Follow commit and branch rules in git-workflow.md.
• Follow the pull request structure in .github/PULL_REQUEST_TEMPLATE.md.
• Update related documentation when behavior or usage changes.

6. Related references

• Project structure and ownership: repository-map.md
• Release process (maintainers): publishing.md
• End-user execution steps: quick-start.md