From 5ed2ab92f2df7cce7adf2f221a457b43e856914b Mon Sep 17 00:00:00 2001 From: tim neutkens Date: Sun, 5 Feb 2017 22:40:21 +0100 Subject: [PATCH 1/2] Add contributing.md --- CONTRIBUTING.md | 10 ++++++++++ README.md | 4 ++++ 2 files changed, 14 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000000..211909506c66b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +# Contributing to Next.js + +Our Commitment to Open Source can be found [here](https://zeit.co/blog/oss) + +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 in a new terminal to build and watch for code changes +5. Then npm link this repo inside any example app with `npm link next` +6. Then you can run your example app with the local version of Next.js (You may need to re-run example app as you change code in the Next.js repository diff --git a/README.md b/README.md index 67a858661b31b..f246c4d4f5c00 100644 --- a/README.md +++ b/README.md @@ -674,6 +674,10 @@ As we were researching options for server-rendering React that didn’t involve Our Roadmap towards 2.0.0 [is public](https://github.com/zeit/next.js/wiki/Roadmap#nextjs-200). +## Contributing + +Please see our [CONTRIBUTING.md](./CONTRIBUTING.md) + ## Authors - Naoyuki Kanezawa ([@nkzawa](https://twitter.com/nkzawa)) – ▲ZEIT From ce5e796c74cd7513a5bed0671c63b33e1fd0893a Mon Sep 17 00:00:00 2001 From: tim neutkens Date: Mon, 6 Feb 2017 10:42:50 +0100 Subject: [PATCH 2/2] Only reload example app on server changes --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 211909506c66b..f7de24f0650d8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,4 +7,4 @@ Our Commitment to Open Source can be found [here](https://zeit.co/blog/oss) 3. Run `npm link` to link the local repo to NPM 4. Run npm run build in a new terminal to build and watch for code changes 5. Then npm link this repo inside any example app with `npm link next` -6. Then you can run your example app with the local version of Next.js (You may need to re-run example app as you change code in the Next.js repository +6. Then you can run your example app with the local version of Next.js (You may need to re-run the example app as you change server side code in the Next.js repository)