Skip to content

Commit 3ff21ed

Browse files
balazsorban44timneutkensijjk
authored
refactor: split up CONTRIBUTING.md (vercel#40515)
Continues vercel#39778 Closes vercel#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 <[email protected]> Co-authored-by: JJ Kasper <[email protected]>
1 parent cade8c8 commit 3ff21ed

24 files changed

+498
-417
lines changed

Diff for: ‎.github/pull_request_template.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<!--
22
Thanks for opening a PR! Your contribution is much appreciated.
3-
In order to make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below.
3+
To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below.
44
Choose the right checklist for the change that you're making:
55
-->
66

77
## Bug
88

99
- [ ] Related issues linked using `fixes #number`
1010
- [ ] Integration tests added
11-
- [ ] Errors have helpful link attached, see `contributing.md`
11+
- [ ] Errors have a helpful link attached, see `contributing.md`
1212

1313
## Feature
1414

@@ -17,9 +17,9 @@ Choose the right checklist for the change that you're making:
1717
- [ ] Integration tests added
1818
- [ ] Documentation added
1919
- [ ] Telemetry added. In case of a feature if it's used or not.
20-
- [ ] Errors have helpful link attached, see `contributing.md`
20+
- [ ] Errors have a helpful link attached, see `contributing.md`
2121

2222
## Documentation / Examples
2323

2424
- [ ] Make sure the linting passes by running `pnpm lint`
25-
- [ ] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)
25+
- [ ] The "examples guidelines" are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md)

Diff for: ‎.vscode/launch.json

+27-38
Original file line numberDiff line numberDiff line change
@@ -9,92 +9,81 @@
99
"type": "node",
1010
"request": "launch",
1111
"cwd": "${workspaceFolder}",
12-
"runtimeExecutable": "yarn",
13-
"runtimeArgs": ["run", "debug-react-exp", "dev", "test/e2e/app-dir/app"],
12+
"runtimeExecutable": "pnpm",
13+
"runtimeArgs": ["debug-react-exp", "dev", "test/e2e/app-dir/app"],
1414
"skipFiles": ["<node_internals>/**"],
15-
"outFiles": ["${workspaceFolder}/packages/next/dist/**/*"],
16-
"port": 9229,
1715
"env": {
18-
"NEXT_PRIVATE_LOCAL_WEBPACK5": "1"
16+
"NEXT_PRIVATE_LOCAL_WEBPACK": "1"
1917
}
2018
},
2119
{
2220
"name": "Launch app development",
2321
"type": "node",
2422
"request": "launch",
2523
"cwd": "${workspaceFolder}",
26-
"runtimeExecutable": "yarn",
27-
"runtimeArgs": ["run", "debug", "dev", "bench/nested-deps"],
24+
"runtimeExecutable": "pnpm",
25+
"runtimeArgs": ["debug", "dev", "examples/hello-world"],
2826
"skipFiles": ["<node_internals>/**"],
29-
"outFiles": ["${workspaceFolder}/packages/next/dist/**/*"],
30-
"port": 9229,
3127
"env": {
32-
"NEXT_PRIVATE_LOCAL_WEBPACK5": "1"
28+
"NEXT_PRIVATE_LOCAL_WEBPACK": "1"
3329
}
3430
},
3531
{
3632
"name": "Launch app build",
3733
"type": "node",
3834
"request": "launch",
3935
"cwd": "${workspaceFolder}",
40-
"runtimeExecutable": "yarn",
41-
"runtimeArgs": ["run", "debug", "build", "bench/nested-deps"],
36+
"runtimeExecutable": "pnpm",
37+
"runtimeArgs": ["debug", "build", "examples/hello-world"],
4238
"skipFiles": ["<node_internals>/**"],
43-
"port": 9229,
44-
"outFiles": ["${workspaceFolder}/packages/next/dist/**/*"],
4539
"env": {
46-
"NEXT_PRIVATE_LOCAL_WEBPACK5": "1"
40+
"NEXT_PRIVATE_LOCAL_WEBPACK": "1"
4741
}
4842
},
4943
{
50-
"name": "Launch app build trace jaeger",
44+
"name": "Launch app production",
5145
"type": "node",
5246
"request": "launch",
5347
"cwd": "${workspaceFolder}",
54-
"runtimeExecutable": "yarn",
55-
"runtimeArgs": ["run", "clean-trace-jaeger"],
48+
"runtimeExecutable": "pnpm",
49+
"runtimeArgs": ["debug", "start", "examples/hello-world"],
5650
"skipFiles": ["<node_internals>/**"],
57-
"port": 9229,
58-
"outFiles": ["${workspaceFolder}/packages/next/dist/**/*"],
5951
"env": {
60-
"NEXT_PRIVATE_LOCAL_WEBPACK5": "1"
52+
"NEXT_PRIVATE_LOCAL_WEBPACK": "1"
6153
}
6254
},
6355
{
64-
"name": "Launch app production",
56+
"name": "Launch current directory in development",
6557
"type": "node",
6658
"request": "launch",
6759
"cwd": "${workspaceFolder}",
68-
"runtimeExecutable": "yarn",
69-
"runtimeArgs": ["run", "debug", "start", "bench/nested-deps"],
60+
"runtimeExecutable": "pnpm",
61+
"runtimeArgs": ["debug", "dev", "${fileDirname}"],
7062
"skipFiles": ["<node_internals>/**"],
71-
"port": 9229,
7263
"env": {
73-
"NEXT_PRIVATE_LOCAL_WEBPACK5": "1"
64+
"NEXT_PRIVATE_LOCAL_WEBPACK": "1"
7465
}
7566
},
7667
{
68+
"name": "Launch app build trace jaeger",
7769
"type": "node",
78-
"request": "attach",
79-
"name": "Attach to existing debugger",
80-
"port": 9229,
70+
"request": "launch",
71+
"cwd": "${workspaceFolder}",
72+
"runtimeExecutable": "pnpm",
73+
"runtimeArgs": ["clean-trace-jaeger"],
8174
"skipFiles": ["<node_internals>/**"],
82-
"outFiles": ["${workspaceFolder}/packages/next/dist/**/*"],
8375
"env": {
84-
"NEXT_PRIVATE_LOCAL_WEBPACK5": "1"
76+
"NEXT_PRIVATE_LOCAL_WEBPACK": "1"
8577
}
8678
},
8779
{
88-
"name": "Launch this example",
8980
"type": "node",
90-
"request": "launch",
91-
"cwd": "${workspaceFolder}",
92-
"runtimeExecutable": "yarn",
93-
"runtimeArgs": ["run", "debug", "dev", "${fileDirname}"],
94-
"skipFiles": ["<node_internals>/**"],
81+
"request": "attach",
82+
"name": "Attach to existing debugger",
9583
"port": 9229,
84+
"skipFiles": ["<node_internals>/**"],
9685
"env": {
97-
"NEXT_PRIVATE_LOCAL_WEBPACK5": "1"
86+
"NEXT_PRIVATE_LOCAL_WEBPACK": "1"
9887
}
9988
}
10089
]

Diff for: ‎bench/nested-deps/package.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
22
"scripts": {
33
"prepare": "rimraf components && mkdir components && node ./fuzzponent.js -d 2 -s 206 -o components",
4-
"dev": "cross-env NEXT_PRIVATE_LOCAL_WEBPACK5=1 node ../../node_modules/next/dist/bin/next dev",
5-
"build": "cross-env NEXT_PRIVATE_LOCAL_WEBPACK5=1 node ../../node_modules/next/dist/bin/next build",
6-
"start": "cross-env NEXT_PRIVATE_LOCAL_WEBPACK5=1 node ../../node_modules/next/dist/bin/next start",
4+
"dev": "cross-env NEXT_PRIVATE_LOCAL_WEBPACK=1 node ../../node_modules/next/dist/bin/next dev",
5+
"build": "cross-env NEXT_PRIVATE_LOCAL_WEBPACK=1 node ../../node_modules/next/dist/bin/next build",
6+
"start": "cross-env NEXT_PRIVATE_LOCAL_WEBPACK=1 node ../../node_modules/next/dist/bin/next start",
77
"dev-nocache": "rimraf .next && yarn dev",
8-
"dev-cpuprofile-nocache": "rimraf .next && cross-env NEXT_PRIVATE_LOCAL_WEBPACK5=1 node --cpu-prof ../../node_modules/next/dist/bin/next",
8+
"dev-cpuprofile-nocache": "rimraf .next && cross-env NEXT_PRIVATE_LOCAL_WEBPACK=1 node --cpu-prof ../../node_modules/next/dist/bin/next",
99
"build-nocache": "rimraf .next && yarn build"
1010
},
1111
"devDependencies": {

0 commit comments

Comments
 (0)