Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (22 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

34 lines (22 loc) · 1.13 KB
Raw

Contributing

Thanks for helping improve AI Charts.

Development

Install Bun 1.3.14 and Node.js 24, then run:

bun install --frozen-lockfile
bun run dev

Keep changes focused and include deterministic tests for behavior. Property tests are preferred for parsers, ordering, scale laws, layout geometry, and round trips.

Before opening a pull request, run:

bun run check

Data changes

Do not hand-edit data/coding-agents.json. Run bun run data:refresh, inspect the diff, and include only a snapshot change supported by the guarded refresh script. Do not weaken retention or coverage checks merely to accept an unexpected upstream shape.

Do not hand-edit lib/chart-colors.generated.ts. Regenerate it with bun run colors:generate.

Product boundaries

  • Keep the production route independent of live upstream availability.
  • Treat file, network, URL, and query-string input as untrusted.
  • Preserve keyboard, pointer, touch, and focus behavior together.
  • Do not add user accounts, a product database, or identifying analytics without a separately reviewed design.
  • Never commit credentials or real PostHog private keys.