Get Started

Contributing

We can never thank you enough for your contributions.
It is highly recommended to read Nuxt contribution guide before making any contributions.

How to contribute?

  • Clone nuxt/image repository
  • Enable Corepack using corepack enable
  • Install dependencies using pnpm install
  • Run pnpm dev:prepare to generate type stubs.

Nuxt Image

  • Use pnpm dev to start the playground in development mode.
  • Apply your changes
  • Add tests into the test/ directory and run pnpm test to make sure they pass.
  • Check the code style with pnpm lint
  • Before creating a PR, make sure to run pnpm build and that no errors are reported.

Documentation