Contributing

Thank you for wanting to contribute to Nitro 💛

Before everything, please make sure to check the open issues or the dicussions.

To contribute locally:

  • Fork and clone unjs/nitro
  • Enable corepack using corepack enable (use npm i -g corepack for Node.js < 16.10)
  • Install dependencies using pnpm install
  • Activate passive watcher using pnpm stub
  • Start playground with pnpm dev and open http://localhost:3000
    • You can also try examples/ using pnpm nitro dev examples/<name> and pnpm nitro build examples/<name>
  • Make changes
  • Ensure all tests pass using the pnpm test command
  • Open a Pull-Request

You can also run pnpm vitest test/presets/node.test.ts to run a single test.