archive/rsnext
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: make contributing.md more contributor-friendly (#27913)

Browse source 
I originally sought out to add a statement about chromedriver before investing time in making the document as clear as possible for new contributors on the first read. Any notes are very welcome.

- add Ubuntu/Debian `apt install chromedriver` tip
- consistent heading names, subheadings
- formatting
- order changes:
    1. Developing
    2. Building
    3. Testing
    4. Adding warning/error descriptions
    5. Adding examples

## Documentation / Examples

- [x] Make sure the linting passes
This commit is contained in:
C. Lewis 2021-08-17 15:50:33 -05:00 committed by GitHub
parent fe246bae36
commit baeb98e847
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 85 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

122
contributing.md
View file

@ -1,19 +1,46 @@
# Contributing to Next.js
Read about our [Commitment to Open Source](https://vercel.com/oss).
Read about our [Commitment to Open Source](https://vercel.com/oss). To
contribute to [our examples](examples), please see **[Adding
examples](#adding-examples)** below.
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. Create a new branch: `git checkout -b MY_BRANCH_NAME`
3. Install yarn: `npm install -g yarn`
4. Install the dependencies: `yarn`
5. Run `yarn dev` to build and watch for code changes
6. In a new terminal, run `yarn types` to compile declaration files from TypeScript
7. The development branch is `canary` (this is the branch pull requests should be made against). On a release, the relevant parts of the changes in the `canary` branch are rebased into `master`.
## Developing
> You may need to run `yarn types` again if your types get outdated.
The development branch is `canary`, and this is the branch that all pull
requests should be made against. After publishing a stable release, the changes
in the `canary` branch are rebased into `master`. The changes on the `canary`
branch are published to the `@canary` dist-tag daily.
To contribute to [our examples](examples), take a look at the [“Adding examples”
section](#adding-examples).
To develop locally:
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. Create a new branch:
```
git checkout -b MY_BRANCH_NAME
```
3. Install yarn:
```
npm install -g yarn
```
4. Install the dependencies with:
```
yarn
```
5. Start developing and watch for code changes:
```
yarn dev
```
6. In a new terminal, run `yarn types` to compile declaration files from
TypeScript.
_Note: You may need to repeat this step if your types get outdated._
For instructions on how to build a project with your local version of the CLI,
see **[Developing with your local version of Next.js](#developing-with-your-local-version-of-nextjs)**
below. (Naively linking the binary is not sufficient to develop locally.)
## Building
@ -27,31 +54,20 @@ yarn prepublish
If you need to clean the project for any reason, use `yarn clean`.
## Adding warning/error descriptions
## Testing
In Next.js we have a system to add helpful links to warnings and errors.
This allows for the logged message to be short while giving a broader description and instructions on how to solve the warning/error.
In general all warnings and errors added should have these links attached.
Below are the steps to add a new link:
- Create a new markdown file under the `errors` directory based on `errors/template.md`: `cp errors/template.md errors/<error-file-name>.md`
- Add the newly added file to `errors/manifest.json`
- Add the following url to your warning/error: `https://nextjs.org/docs/messages/<file-path-without-dotmd>`. For example to link to `errors/api-routes-static-export.md` you use the url: `https://nextjs.org/docs/messages/api-routes-static-export`
## To run tests
Make sure you have `chromedriver` installed for your Chrome version. You can install it with
Make sure you have `chromedriver` installed, and it should match your Chrome version.
You can install it with:
- `apt install chromedriver` on Ubuntu/Debian
- `brew install --cask chromedriver` on Mac OS X
- `chocolatey install chromedriver` on Windows
- Or manually download the version that matches your installed chrome version (if there's no match, download a version under it, but not above) from the [chromedriver repo](https://chromedriver.storage.googleapis.com/index.html) and add the binary to `<next-repo>/node_modules/.bin`
You may also have to [install Rust](https://www.rust-lang.org/tools/install) and build our native packages to see all tests pass locally. We check in binaries for the most common targets and those required for CI so that most people don't have to, but if you do not see a binary for your target in `packages/next/native`, you can build it by running `yarn --cwd packages/next build-native`. If you are working on the Rust code and you need to build the binaries for ci, you can manually trigger [the workflow](https://github.com/vercel/next.js/actions/workflows/build_native.yml) to build and commit with the "Run workflow" button.
Running all tests:
### Running tests
```sh
yarn testonly
@ -81,7 +97,7 @@ Running one test in the `production` test suite:
yarn testonly --testPathPattern "production" -t "should allow etag header support"
```
## Running the integration apps
### Running the integration apps
Running examples can be done with:
@ -106,15 +122,11 @@ EXAMPLE=./test/integration/basic
)
```
## Running your own app with locally compiled version of Next.js
## Developing with your local version of Next.js
1. Move your app inside of the Next.js monorepo.
There are two options to develop with your local version of the codebase:
2. Run with `yarn next-with-deps ./app-path-in-monorepo`
This will use the version of `next` built inside of the Next.js monorepo and the main `yarn dev` monorepo command can be running to make changes to the local Next.js version at the same time (some changes might require re-running `yarn next-with-deps` to take affect).
or
### Set as local dependency in package.json
1. In your app's `package.json`, replace:
@ -125,7 +137,7 @@ or
with:
```json
"next": "file:<local-path-to-cloned-nextjs-repo>/packages/next",
"next": "file:/path/to/next.js/packages/next",
```
2. In your app's root directory, make sure to remove `next` from `node_modules` with:
@ -152,6 +164,42 @@ or
yarn install --force
```
or
### Develop inside the monorepo
1. Move your app inside of the Next.js monorepo.
2. Run with `yarn next-with-deps ./app-path-in-monorepo`
This will use the version of `next` built inside of the Next.js monorepo and the
main `yarn dev` monorepo command can be running to make changes to the local
Next.js version at the same time (some changes might require re-running `yarn next-with-deps` to take affect).
## Adding warning/error descriptions
In Next.js we have a system to add helpful links to warnings and errors.
This allows for the logged message to be short while giving a broader description and instructions on how to solve the warning/error.
In general all warnings and errors added should have these links attached.
Below are the steps to add a new link:
1. Create a new markdown file under the `errors` directory based on
`errors/template.md`:
```shell
cp errors/template.md errors/<error-file-name>.md
```
2. Add the newly added file to `errors/manifest.json`
3. Add the following url to your warning/error:
`https://nextjs.org/docs/messages/<file-path-without-dotmd>`.
For example, to link to `errors/api-routes-static-export.md` you use the url:
`https://nextjs.org/docs/messages/api-routes-static-export`
## Adding examples
When you add an example to the [examples](examples) directory, don’t forget to add a `README.md` file with the following format: