-
Notifications
You must be signed in to change notification settings - Fork 286
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
29 additions
and
0 deletions.
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
title: Contributing | ||
description: We can never thank you enough for your contributions. ❤️ | ||
--- | ||
|
||
::callout | ||
It is highly recommended to read [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 | ||
- 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](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 | ||
|
||
- Use `pnpm dev:docs` to start the [documentation](https://github.com/nuxt/image/tree/main/docs) in development mode. | ||
- Open [http://localhost:3000](http://localhost:3000) to view it in the browser. | ||
- Update the content of the documentation in the [docs/content/](https://github.com/nuxt/image/tree/main/docs/content) directory. |