-
Notifications
You must be signed in to change notification settings - Fork 29.9k
README: improve getting started & contributing #101
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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 |
README.md
Outdated
| "dependencies": { | ||
| "next": "latest" | ||
| } | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.