diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..f7de24f0 --- /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 the example app as you change server side code in the Next.js repository) diff --git a/README.md b/README.md index 67a85866..f246c4d4 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