Skip to content

Commit

Permalink
docs: add contribution guide
Browse files Browse the repository at this point in the history
  • Loading branch information
atinux committed Sep 22, 2023
1 parent a9cc6bd commit fdc0975
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 0 deletions.
File renamed without changes.
29 changes: 29 additions & 0 deletions docs/content/1.get-started/4.contributing.md
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.

0 comments on commit fdc0975

Please sign in to comment.