---
title: "Contributing"
description: "We can never thank you enough for your contributions."
canonical_url: "https://nuxt.com/modules/hints/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.
::

## Development

- Clone the [nuxt/hints](https://github.com/nuxt/hints) repository
- Enable Corepack using `corepack enable`
- Apply your changes, then check them with the commands below

```bash
# Install dependencies
pnpm install

# Generate type stubs
pnpm run dev:prepare

# Develop with the playground
pnpm run dev

# Build the playground
pnpm run dev:build

# Run ESLint
pnpm run lint

# Run Vitest
pnpm run test
pnpm run test:watch
```

## Documentation

The documentation lives in the [`docs/`](https://github.com/nuxt/hints/tree/main/docs) directory and is published on [nuxt.com/modules/hints](https://nuxt.com/modules/hints). Keep images next to the pages in `docs/images/` and link them with a relative path, such as `![Hints tab](./images/devtools-homepage.png)`.

To preview your changes, run the [nuxt.com](https://github.com/nuxt/nuxt.com) dev server with `NUXT_HINTS_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.