---
title: "Contributing"
description: "We can never thank you enough for your contributions."
canonical_url: "https://nuxt.com/modules/image/contributing"
---
# Contributing

> We can never thank you enough for your contributions.

::warning
It is highly recommended to read the [Nuxt contribution guide](https://nuxt.com/docs/community/contribution) before making any contributions.
::

## How to contribute?

- Clone [nuxt/image](https://github.com/nuxt/image) repository
- Install [pnpm](https://pnpm.io/installation)
- Install dependencies using `pnpm install`
- Run `pnpm dev:prepare` to generate type stubs.

### Nuxt Image

- Use `pnpm dev` to start the [playground](https://github.com/nuxt/image/tree/main/playground) in development mode.
- Apply your changes
- Add tests into the [test/](https://github.com/nuxt/image/tree/main/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

The documentation lives in the [`docs/`](https://github.com/nuxt/image/tree/main/docs) directory and is published on [nuxt.com/modules/image](https://nuxt.com/modules/image).

To preview your changes, run the [nuxt.com](https://github.com/nuxt/nuxt.com) dev server with `NUXT_IMAGE_PATH` set to your local clone of this repo. Pull requests changing `docs/` can also be previewed on [nuxt.com](http://nuxt.com) once a maintainer adds the `preview:enabled` label.


## Sitemap

See the full [sitemap](https://nuxt.com/sitemap.md) for all pages.