Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (29 loc) · 893 Bytes

CONTRIBUTING.md

File metadata and controls

41 lines (29 loc) · 893 Bytes

Contributing

Thanks for your interest in hydro.

Local setup

Requirements:

  • Node.js 22+
  • Bun
bun install
bun run dev:prepare

Common commands

bun run lint        # ESLint
bun run test:types  # TypeScript checks for module + playground
bun run test        # Vitest suite
bun run prepack     # Build distributable package
bun run dev:build   # Build playground
bun run verify      # Run the full verification pipeline

Playground

bun run dev

Open http://localhost:3000 and try the generated Book and Author APIs.

Notes for contributors

  • Keep framework-independent logic in src/runtime/core.
  • Keep Nuxt/Nitro integration code in src/module.ts and src/runtime/server.
  • Add tests for every behavior change in test/core.test.ts or test/basic.test.ts.
  • Generated files (dist, .nuxt, .output) should not be committed.