Skip to content

Commit c765d17

Browse files
committedAug 29, 2024··
docs: add contribution instructions
1 parent 93dc63e commit c765d17

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed
 

‎CONTRIBUTING.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
2+
## Contributing
3+
4+
To contribute to Nuxt Test Utils, you need to set up a local environment.
5+
6+
1. [Fork](https://help.github.com/articles/fork-a-repo) the [`nuxt/test-utils`](https://github.com/nuxt/test-utils) repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository) it to your local device.
7+
1. Enable [Corepack](https://github.com/nodejs/corepack) to have access to `pnpm`
8+
```bash [Terminal]
9+
corepack enable
10+
```
11+
1. Run `pnpm install` to install the dependencies with pnpm:
12+
```bash [Terminal]
13+
pnpm install && pnpm playwright install chromium
14+
```
15+
1. Activate the passive development system
16+
```bash [Terminal]
17+
pnpm dev:prepare
18+
```
19+
1. Check out a branch where you can work and commit your changes:
20+
```bash [Terminal]
21+
git checkout -b my-new-branch
22+
```
23+
24+
Then, test your changes against the examples before submitting a pull request.
25+
26+
```bash
27+
pnpm prepack
28+
pnpm test:examples
29+
pnpm dev:prepare
30+
```
31+
32+
Read more in the [Nuxt Contribution Guide](https://nuxt.com/docs/community/contribution#how-to-contribute).

0 commit comments

Comments
 (0)
Please sign in to comment.