---
title: "Contributing"
description: "We can never thank you enough for your contributions."
canonical_url: "https://nuxt.com/modules/fonts/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/fonts](https://github.com/nuxt/fonts) repository
- Enable Corepack using `corepack enable`
- Install dependencies using pnpm install
- Run `pnpm dev:prepare` to generate type stubs.
- 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

The documentation lives in the [`docs/`](https://github.com/nuxt/fonts/tree/main/docs) directory and is published on [nuxt.com/modules/fonts](https://nuxt.com/modules/fonts). Keep images and videos next to the pages in `docs/images/` and link them with a relative path, such as `![Fonts tab](./images/fonts-tab.webp)` or `::video{src="./images/demo.mp4" controls}`.

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