Nuxt/CONTRIBUTING.md

# 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.
2. Install the dependencies: `npm install`.
3. Run `npm link` to link the local repo to NPM.
4. Then npm link this repo 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).
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._

Make sure to add tests into `test/` directory and try them with `npm test` before making a pull request.
Add Contributing.md file 2017-10-16 15:01:19 +00:00			`# 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.`
			2. Install the dependencies: `npm install`.
			3. Run `npm link` to link the local repo to NPM.
updated README with 'npm run' info in nuxt app example 2018-03-19 18:21:51 +00:00			4. Then npm link this repo 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).
			`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).`
be more specific about what it takes to start developing on nuxt 2018-03-17 16:40:14 +00:00
			`_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._`
Update and rename contributing.md to CONTRIBUTING.md 2017-10-20 08:34:47 +00:00
			Make sure to add tests into `test/` directory and try them with `npm test` before making a pull request.