Zengtudor/Nuxt
1
0
Fork 0
mirror of https://github.com/nuxt/nuxt.git synced 2024-11-27 08:02:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md (#3487)

Browse Source
This commit is contained in:
FishPlusOrange 2018-07-01 02:57:49 +08:00 committed by Clark Du
parent 159021eabe
commit d9d2d9e8de
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -1,12 +1,12 @@
# Contributing to Nuxt.js # Contributing to Nuxt.js
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. 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`. 2. Run `npm install` to install the dependencies.
3. Run `npm link` to link the local repo to NPM. 3. Run `npm link` to link the local repository to NPM.
4. Then npm link this repo inside any nuxt example app with `npm link nuxt`. 4. Then npm links this repository inside any nuxt example app with `npm link nuxt`.
5. Run `npm run build` or `npm run dev` inside your example app, if you created it with [nuxt starter template](https://github.com/nuxt-community/starter-template). 5. Run `npm run build` or `npm run dev` inside your example app, if you created it with [nuxt starter template](https://github.com/nuxt-community/starter-template).
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). 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).
_Note that both npm and yarn has been seen to miss installing dependencies. To remedy that, you can either delete the node_modules folder in your example app and install again or do a local install of the missing dependencies._ _Note that both npm and yarn have been seen to miss installing dependencies. To remedy that, you can either delete the node_modules folder in your example app and install again or do a local install of the missing dependencies._
Make sure to add tests into `test/` directory and try them with `npm test` before making a pull request. Make sure to add tests into `test/` directory and try them with `npm test` before making a pull request.