refactor: split up CONTRIBUTING.md (#40515)

Continues #39778 Closes #40499 ## Bug - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Errors have helpful link attached, see `contributing.md` ## Feature - [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Documentation added - [ ] Telemetry added. In case of a feature if it's used or not. - [ ] Errors have helpful link attached, see `contributing.md` ## Documentation / Examples - [ ] Make sure the linting passes by running `pnpm lint` - [ ] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples) Co-authored-by: Tim Neutkens <tim@timneutkens.nl> Co-authored-by: JJ Kasper <jj@jjsweb.site>
vercel · Sep 16, 2022 · 3ff21ed · 3ff21ed
1 parent cade8c8
commit 3ff21ed
Show file tree

Hide file tree

Showing 24 changed files with 498 additions and 417 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,14 +1,14 @@
 <!--
 Thanks for opening a PR! Your contribution is much appreciated.
-In order to make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below.
+To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below.
 Choose the right checklist for the change that you're making:
 -->
 
 ## Bug
 
 - [ ] Related issues linked using `fixes #number`
 - [ ] Integration tests added
-- [ ] Errors have helpful link attached, see `contributing.md`
+- [ ] Errors have a helpful link attached, see `contributing.md`
 
 ## Feature
 
@@ -17,9 +17,9 @@ Choose the right checklist for the change that you're making:
 - [ ] Integration tests added
 - [ ] Documentation added
 - [ ] Telemetry added. In case of a feature if it's used or not.
-- [ ] Errors have helpful link attached, see `contributing.md`
+- [ ] Errors have a helpful link attached, see `contributing.md`
 
 ## Documentation / Examples
 
 - [ ] Make sure the linting passes by running `pnpm lint`
-- [ ] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)
+- [ ] The "examples guidelines" are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md)
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -9,92 +9,81 @@
       "type": "node",
       "request": "launch",
       "cwd": "${workspaceFolder}",
-      "runtimeExecutable": "yarn",
-      "runtimeArgs": ["run", "debug-react-exp", "dev", "test/e2e/app-dir/app"],
+      "runtimeExecutable": "pnpm",
+      "runtimeArgs": ["debug-react-exp", "dev", "test/e2e/app-dir/app"],
       "skipFiles": ["<node_internals>/**"],
-      "outFiles": ["${workspaceFolder}/packages/next/dist/**/*"],
-      "port": 9229,
       "env": {
-        "NEXT_PRIVATE_LOCAL_WEBPACK5": "1"
+        "NEXT_PRIVATE_LOCAL_WEBPACK": "1"
       }
     },
     {
       "name": "Launch app development",
       "type": "node",
       "request": "launch",
       "cwd": "${workspaceFolder}",
-      "runtimeExecutable": "yarn",
-      "runtimeArgs": ["run", "debug", "dev", "bench/nested-deps"],
+      "runtimeExecutable": "pnpm",
+      "runtimeArgs": ["debug", "dev", "examples/hello-world"],
       "skipFiles": ["<node_internals>/**"],
-      "outFiles": ["${workspaceFolder}/packages/next/dist/**/*"],
-      "port": 9229,
       "env": {
-        "NEXT_PRIVATE_LOCAL_WEBPACK5": "1"
+        "NEXT_PRIVATE_LOCAL_WEBPACK": "1"
       }
     },
     {
       "name": "Launch app build",
       "type": "node",
       "request": "launch",
       "cwd": "${workspaceFolder}",
-      "runtimeExecutable": "yarn",
-      "runtimeArgs": ["run", "debug", "build", "bench/nested-deps"],
+      "runtimeExecutable": "pnpm",
+      "runtimeArgs": ["debug", "build", "examples/hello-world"],
       "skipFiles": ["<node_internals>/**"],
-      "port": 9229,
-      "outFiles": ["${workspaceFolder}/packages/next/dist/**/*"],
       "env": {
-        "NEXT_PRIVATE_LOCAL_WEBPACK5": "1"
+        "NEXT_PRIVATE_LOCAL_WEBPACK": "1"
       }
     },
     {
-      "name": "Launch app build trace jaeger",
+      "name": "Launch app production",
       "type": "node",
       "request": "launch",
       "cwd": "${workspaceFolder}",
-      "runtimeExecutable": "yarn",
-      "runtimeArgs": ["run", "clean-trace-jaeger"],
+      "runtimeExecutable": "pnpm",
+      "runtimeArgs": ["debug", "start", "examples/hello-world"],
       "skipFiles": ["<node_internals>/**"],
-      "port": 9229,
-      "outFiles": ["${workspaceFolder}/packages/next/dist/**/*"],
       "env": {
-        "NEXT_PRIVATE_LOCAL_WEBPACK5": "1"
+        "NEXT_PRIVATE_LOCAL_WEBPACK": "1"
       }
     },
     {
-      "name": "Launch app production",
+      "name": "Launch current directory in development",
       "type": "node",
       "request": "launch",
       "cwd": "${workspaceFolder}",
-      "runtimeExecutable": "yarn",
-      "runtimeArgs": ["run", "debug", "start", "bench/nested-deps"],
+      "runtimeExecutable": "pnpm",
+      "runtimeArgs": ["debug", "dev", "${fileDirname}"],
       "skipFiles": ["<node_internals>/**"],
-      "port": 9229,
       "env": {
-        "NEXT_PRIVATE_LOCAL_WEBPACK5": "1"
+        "NEXT_PRIVATE_LOCAL_WEBPACK": "1"
       }
     },
     {
+      "name": "Launch app build trace jaeger",
       "type": "node",
-      "request": "attach",
-      "name": "Attach to existing debugger",
-      "port": 9229,
+      "request": "launch",
+      "cwd": "${workspaceFolder}",
+      "runtimeExecutable": "pnpm",
+      "runtimeArgs": ["clean-trace-jaeger"],
       "skipFiles": ["<node_internals>/**"],
-      "outFiles": ["${workspaceFolder}/packages/next/dist/**/*"],
       "env": {
-        "NEXT_PRIVATE_LOCAL_WEBPACK5": "1"
+        "NEXT_PRIVATE_LOCAL_WEBPACK": "1"
       }
     },
     {
-      "name": "Launch this example",
       "type": "node",
-      "request": "launch",
-      "cwd": "${workspaceFolder}",
-      "runtimeExecutable": "yarn",
-      "runtimeArgs": ["run", "debug", "dev", "${fileDirname}"],
-      "skipFiles": ["<node_internals>/**"],
+      "request": "attach",
+      "name": "Attach to existing debugger",
       "port": 9229,
+      "skipFiles": ["<node_internals>/**"],
       "env": {
-        "NEXT_PRIVATE_LOCAL_WEBPACK5": "1"
+        "NEXT_PRIVATE_LOCAL_WEBPACK": "1"
       }
     }
   ]

diff --git a/bench/nested-deps/package.json b/bench/nested-deps/package.json
@@ -1,11 +1,11 @@
 {
   "scripts": {
     "prepare": "rimraf components && mkdir components && node ./fuzzponent.js -d 2 -s 206 -o components",
-    "dev": "cross-env NEXT_PRIVATE_LOCAL_WEBPACK5=1 node ../../node_modules/next/dist/bin/next dev",
-    "build": "cross-env NEXT_PRIVATE_LOCAL_WEBPACK5=1 node ../../node_modules/next/dist/bin/next build",
-    "start": "cross-env NEXT_PRIVATE_LOCAL_WEBPACK5=1 node ../../node_modules/next/dist/bin/next start",
+    "dev": "cross-env NEXT_PRIVATE_LOCAL_WEBPACK=1 node ../../node_modules/next/dist/bin/next dev",
+    "build": "cross-env NEXT_PRIVATE_LOCAL_WEBPACK=1 node ../../node_modules/next/dist/bin/next build",
+    "start": "cross-env NEXT_PRIVATE_LOCAL_WEBPACK=1 node ../../node_modules/next/dist/bin/next start",
     "dev-nocache": "rimraf .next && yarn dev",
-    "dev-cpuprofile-nocache": "rimraf .next && cross-env NEXT_PRIVATE_LOCAL_WEBPACK5=1 node --cpu-prof ../../node_modules/next/dist/bin/next",
+    "dev-cpuprofile-nocache": "rimraf .next && cross-env NEXT_PRIVATE_LOCAL_WEBPACK=1 node --cpu-prof ../../node_modules/next/dist/bin/next",
     "build-nocache": "rimraf .next && yarn build"
   },
   "devDependencies": {