Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (39 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

65 lines (39 loc) · 2.81 KB

Contribution Guide

All contributors lead the growth of Nitro - including you!

Discussions

You can involve in discussions using:

Contribute to the Code

Important

Please discuss your ideas with the maintainers before opening a pull request.

Local Development

  • Clone the nitrojs/nitro git repository.
  • Install the latest LTS version of Node.js (v22+).
  • Enable corepack using corepack enable (run npm i -g corepack if it's not available).
  • Install dependencies using pnpm install.
  • Build the project in stub mode using pnpm build --stub.
  • Run the playground with pnpm nitro dev ./playground to verify changes.
  • Add, modify, and run tests using pnpm test.
    • Tip: Run pnpm vitest test/presets/node.test.ts for quick testing.

Reporting Issues

You might encounter a bug while using Nitro.

Although we aim to resolve all known issues, new bugs can emerge over time. Your bug report helps us find and fix them faster — even if you're unable to fix the underlying code yourself.

Here’s how to report a bug effectively:

Ensure It's a Bug

Sometimes what seems like a bug may actually be expected behavior or a missing feature. Make sure you’re reporting an actual bug by creating a minimal nitro project and reducing scope.

Create a Minimal Reproduction

Please create a minimal reproduction using the Nitro starter templates.

Sometimes, bugs originate from another layer — not Nitro itself. A minimal reproduction helps identify the source and speeds up debugging.

Use one of the following templates to reproduce the issue:

If your bug involves a higher-level framework like Nuxt, please report it there. Maintainers will help narrow it down to a Nitro-level issue if needed.

Search Existing Issues and Discussions

Before creating a new issue, search existing issues and discussions to see if your bug has already been reported.

If it has already been reported:

  • Add a 👍 reaction to the original post (instead of commenting "me too" or "when will it be fixed").
  • If you can provide additional context or a better/smaller reproduction, please share it.

Note

If the issue seems related but different or old or already closed, it's better to open a new issue. Maintainers will merge similar issues if needed.