From 9a5bfe6cb49d0d01a099fa08830e0a82c3998891 Mon Sep 17 00:00:00 2001 From: Ademola Adegbuyi Date: Mon, 16 Oct 2017 16:01:19 +0100 Subject: [PATCH] Add Contributing.md file --- .contributing.md | 8 ++++++++ README.md | 5 ++++- 2 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 .contributing.md diff --git a/.contributing.md b/.contributing.md new file mode 100644 index 0000000000..1e3b5d528a --- /dev/null +++ b/.contributing.md @@ -0,0 +1,8 @@ +# 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. Run `npm run build` 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 diff --git a/README.md b/README.md index 224ba8c977..75f5826a6b 100644 --- a/README.md +++ b/README.md @@ -164,7 +164,7 @@ You can start by using one of our starter templates: - [koa](https://github.com/nuxt-community/koa-template): Nuxt.js + Koa - [adonuxt](https://github.com/nuxt-community/adonuxt-template): Nuxt.js + AdonisJS - [micro](https://github.com/nuxt-community/micro-template): Nuxt.js + Micro -- [nuxtent](https://github.com/nuxt-community/nuxtent-template): Nuxt.js + Nuxtent module for content heavy sites +- [nuxtent](https://github.com/nuxt-community/nuxtent-template): Nuxt.js + Nuxtent module for content heavy sites ## Using nuxt.js programmatically @@ -252,3 +252,6 @@ Note: we recommend putting `.nuxt` in `.npmignore` or `.gitignore`. ## Roadmap https://github.com/nuxt/nuxt.js/projects/1 + +## Contributing +Please see our [contributing.md](./contributing.md) \ No newline at end of file