Zengtudor/Nuxt
1
0
Fork 0
mirror of https://github.com/nuxt/nuxt.git synced 2024-11-26 23:52:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: note about setup and yarn/npm to contrib guide (#4182)

Browse Source 
As per recent discussion in #core about setting up the repo for development and testing.
This commit is contained in:
Jonas Galvez 2018-10-24 10:33:49 -03:00 committed by Clark Du
parent e876ce6c3d
commit 81b25ee2e2
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -32,6 +32,18 @@ or [bug report](https://bug.nuxtjs.org/).
A great PR, whether it includes a bug fix or a new feature, will often include tests.
To write great tests, let us explain our test structure:
### Setup
Before running any tests, make sure all dependencies are met and build all packages:
```sh
yarn
yarn build
yarn test
```
You **must** use `yarn` to install dependencies as it'll properly resolve all dependencies from sub-packages as well, eliminating the need to `npm link` all required packages.
#### Fixtures
The fixtures (found under `tests/fixtures`) contain several Nuxt applications. To keep build time as short as possible,