Skip to content
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

refactor: split up CONTRIBUTING.md #40515

Merged
merged 29 commits into from Sep 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
b118a48
Split contributing.md into directory
timneutkens Aug 19, 2022
c148fe2
Update linting
timneutkens Aug 19, 2022
cf50a2d
Add information about publishing
timneutkens Aug 19, 2022
d81f2a7
Add note on how version is decided
timneutkens Aug 19, 2022
2b4f437
Change order and rename maintenance -> repository
timneutkens Aug 19, 2022
0c28eb0
Add GitHub CLI recommendation instead of fork link
timneutkens Aug 19, 2022
338f60d
Add additional notes on running tests and simplify command to pnpm test
timneutkens Aug 19, 2022
3346f7a
Update explanation on build
timneutkens Aug 19, 2022
eaee5bf
Reword error-links
timneutkens Aug 19, 2022
8be9a9c
Comment out todo
timneutkens Aug 20, 2022
323d2d5
Ask why and the fix for errors
timneutkens Aug 20, 2022
a5de8b5
Log the url for the error
timneutkens Aug 20, 2022
74e857b
Add placeholder for vscode debugger
timneutkens Aug 20, 2022
22f8f85
Merge branch 'canary' into add/refactor-contributing
balazsorban44 Sep 13, 2022
89afdef
mention `pnpm next`
balazsorban44 Sep 13, 2022
21a7614
`stable` -> `canary`
balazsorban44 Sep 13, 2022
8471e2f
add GitHub CLI install link
balazsorban44 Sep 13, 2022
b12aecf
remove redundant section
balazsorban44 Sep 13, 2022
87c6c0d
simplify local dependency development notes
balazsorban44 Sep 14, 2022
c7ab3e8
tweak testing docs
balazsorban44 Sep 15, 2022
3a5cb13
add "Using the VS Code Debugger"
balazsorban44 Sep 15, 2022
208034b
simplify launch.json
balazsorban44 Sep 15, 2022
af44a54
add back env to `launch.json`
balazsorban44 Sep 15, 2022
f5b5348
Update contributing.md
balazsorban44 Sep 16, 2022
5077009
Update testing.md
balazsorban44 Sep 16, 2022
47befbe
fix LOCAL_WEBPACK casing
ijjk Sep 16, 2022
c78a1a7
add contributing to docs change
ijjk Sep 16, 2022
cd5186d
Merge branch 'canary' into add/refactor-contributing
ijjk Sep 16, 2022
ffd5395
fix formatting
ijjk Sep 16, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions .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

Expand All @@ -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)
65 changes: 27 additions & 38 deletions .vscode/launch.json
Expand Up @@ -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",
balazsorban44 marked this conversation as resolved.
Show resolved Hide resolved
"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"
}
}
]
Expand Down
8 changes: 4 additions & 4 deletions 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": {
Expand Down