Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (39 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

59 lines (39 loc) · 1.25 KB

Contributing

Thanks for your interest in contributing to Geminiano.

Getting started

Prerequisites:

  • Bun >= 1.3.3
  • A Google AI Studio API key

Setup:

bun install

Create .env.local in the project root:

GOOGLE_GENERATIVE_AI_API_KEY="YOUR_GOOGLE_AI_STUDIO_KEY"

Start the dev server:

bun run dev

Development workflow

  • Keep PRs focused and small where possible.
  • Update docs/README.md when changing APIs, storage formats, or policy logic.
  • Add or update tests for logic changes in src/lib, src/validators, or src/tools.
  • Follow existing formatting: 2-space indentation, semicolons, double quotes.

Scripts

Run these before opening a PR:

bun run lint
bun run typecheck
bun run test

Data and privacy

  • Do not commit anything under data/ or invoices/.
  • These folders can contain PII (clients, invoices, ledger, logs).
  • Use bun run data:wipe or bun run data:wipe:all to reset local state.

Reporting issues

  • Include clear reproduction steps and the expected vs. actual behavior.
  • If reporting AI/tooling issues, include a redacted request/response trace.

Security

If you discover a security issue, please report it privately to the maintainer instead of opening a public issue.