diff --git a/contributing.md b/CONTRIBUTING.md similarity index 68% rename from contributing.md rename to CONTRIBUTING.md index 1e3b5d528a..966a162f9a 100644 --- a/contributing.md +++ b/CONTRIBUTING.md @@ -3,6 +3,8 @@ 1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device. 2. Install the dependencies: `npm install`. 3. Run `npm link` to link the local repo to NPM. -4. Run `npm run build` to build and watch for code changes. +4. Run `npm run build` to build or `npm run watch` to build and watch for code changes. 5. Then npm link this repo inside any example app with `npm link nuxt`. -6. Then you can run your example app with the local version of Nuxt.js (You may need to re-run the example app as you change server side code in the Nuxt.js repository). \ No newline at end of file +6. Then you can run your example app with the local version of Nuxt.js (You may need to re-run the example app as you change server side code in the Nuxt.js repository). + +Make sure to add tests into `test/` directory and try them with `npm test` before making a pull request.