Skip to content

Commit fdc0975

Browse files
committed
docs: add contribution guide
1 parent a9cc6bd commit fdc0975

3 files changed

Lines changed: 29 additions & 0 deletions

File tree

File renamed without changes.
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: Contributing
3+
description: We can never thank you enough for your contributions. ❤️
4+
---
5+
6+
::callout
7+
It is highly recommended to read [Nuxt contribution guide](https://nuxt.com/docs/community/contribution) before making any contributions.
8+
::
9+
10+
## How to contribute?
11+
12+
- Clone [nuxt/image](https://github.com/nuxt/image) repository
13+
- Enable Corepack using `corepack enable`
14+
- Install dependencies using `pnpm install`
15+
- Run `pnpm dev:prepare` to generate type stubs.
16+
17+
### Nuxt Image
18+
19+
- Use `pnpm dev` to start the [playground](https://github.com/nuxt/image/tree/main/playground) in development mode.
20+
- Apply your changes
21+
- Add tests into the [test/](https://github.com/nuxt/image/tree/main/test) directory and run `pnpm test` to make sure they pass.
22+
- Check the code style with `pnpm lint`
23+
- Before creating a PR, make sure to run `pnpm build` and that no errors are reported.
24+
25+
### Documentation
26+
27+
- Use `pnpm dev:docs` to start the [documentation](https://github.com/nuxt/image/tree/main/docs) in development mode.
28+
- Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
29+
- Update the content of the documentation in the [docs/content/](https://github.com/nuxt/image/tree/main/docs/content) directory.

0 commit comments

Comments
 (0)