From 81b25ee2e22577ea9704e9e135c927cff266bd18 Mon Sep 17 00:00:00 2001 From: Jonas Galvez Date: Wed, 24 Oct 2018 10:33:49 -0300 Subject: [PATCH] chore: note about setup and yarn/npm to contrib guide (#4182) As per recent discussion in #core about setting up the repo for development and testing. --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e4c7491ec9..2a68f04289 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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,