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:prepareto generate type stubs.
Nuxt Image
- Use
pnpm devto start the playground in development mode. - Apply your changes
- Add tests into the test/ directory and run
pnpm testto make sure they pass. - Check the code style with
pnpm lint - Before creating a PR, make sure to run
pnpm buildand that no errors are reported.
Documentation
- Use
pnpm docs:devto start the documentation in development mode. - Open http://localhost:3000 to view it in the browser.
- Update the content of the documentation in the docs/content/ directory.