terribleplan/next.js
1
0
Fork 0
mirror of https://github.com/terribleplan/next.js.git synced 2024-01-19 02:48:18 +00:00
Code Issues Releases Wiki Activity

Add contributing.md (#1009)

Browse source 
* Add contributing.md

* Only reload example app on server changes
This commit is contained in:
Tim Neutkens 2017-02-06 14:19:34 +01:00 committed by Arunoda Susiripala
parent 6832fea9f1
commit 8c1808d7d7
2 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
CONTRIBUTING.md Normal file
View file

@ -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)

4
README.md
View file

@ -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