README: improve getting started & contributing#101
README: improve getting started & contributing#101flybayer wants to merge 1 commit intovercel:masterfrom flybayer:improve-readme
Conversation
|
Needs rebase since we improved the first section already. The rest should be interesting though! |
|
@rauchg rebased! As you can see, I propose abandoning |
|
Shouldn't |
|
@sedubois, see the |
|
@flybayer |
|
Honestly I like the idea of being explicit about development. We routinely get error reports from people trying to launch dev environments to production (not just to now, but really we've seen every PaaS). This problem is similarly experienced with React, where the default script is the dev build, and production is |
|
Ok, I've updated this PR to use |
There was a problem hiding this comment.
I think this could be step 1 or 2, and then we use npm install? Otherwise this overrides the value of --save
rauchg
left a comment
There was a problem hiding this comment.
We can still improve the 1,2,3 I think
|
@rauchg I reworked the beginning a bit. Do you like this better? |
| 2. Install the dependencies: `npm install` | ||
| 3. Build and test the code: `npm test` | ||
|
|
||
| After that, you'll see the binaries in the `./dist/` folder. |
There was a problem hiding this comment.
I'd suggest to add more items to this list.
- Run
npm linkto link the local repo to NPM - Run
npm run buildin a new terminal to build and watch for code changes - Then npm link this repo inside any example app with
npm link next - Then you can run your example app with local version of Next.js
(You may need to re-run example app as you change code in the Next.js repo)
|
I believe we've improved this now. A better Contributing section in a different PR would be sweet though |
This addresses some things I was first confused by and some common confusions like the
.nextdirectory.It also adds a
ContributingandBackground & Design Philosophysection.