f1fba5b456
## What? This PR has its main goal to improve the experience of opening/reviewing a PR. It improves the PR template, as well as extends PR auto-labeling. ## Why? There are 2 parts to the PR template: - Individual contributors: The current template accommodates for the most common cases individual contributors use to contribute. (I.e. fixing bugs, updating/adding examples, addressing documentation issues). The new template keeps this at the top. - Next.js team: As maintainers, we should try to explain PRs as if someone with less context would review them. This should also help with backreferencing PRs in issues and follow-up PRs and make it easier to follow changes, understand trade-offs better at the time, and help new team members catch up over time, etc. ## How? The template is written in a comment instead of Markdown, so when the PR is opened, most of the template is hidden to make it less verbose. The checkboxes we've had before are not shown, but we already auto-label PRs based on the path of the files that have been touched, so the checkboxes showed redundant information. [Slack thread](https://vercel.slack.com/archives/C04DUD7EB1B/p1677677802109289), Closes NEXT-741
45 lines
1.9 KiB
Markdown
45 lines
1.9 KiB
Markdown
<!-- Thanks for opening a PR! Your contribution is much appreciated.
|
|
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(s) that you're making:
|
|
|
|
## For Contributors
|
|
|
|
### Improving Documentation or adding/fixing Examples
|
|
|
|
- The "examples guidelines" are followed from our contributing doc https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
|
|
- Make sure the linting passes by running `pnpm build && pnpm lint`. See https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md
|
|
|
|
### Fixing a bug
|
|
|
|
- Related issues linked using `fixes #number`
|
|
- Tests added. See: https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
|
|
- Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md
|
|
|
|
### Adding a feature
|
|
|
|
- Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. (A discussion must be opened, see https://github.com/vercel/next.js/discussions/new?category=ideas)
|
|
- Related issues/discussions are linked using `fixes #number`
|
|
- e2e tests added (https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
|
|
- Documentation added
|
|
- Telemetry added. In case of a feature if it's used or not.
|
|
- Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md
|
|
|
|
|
|
|
|
## For Maintainers
|
|
|
|
- Minimal description (aim for explaining to someone not on the team to understand the PR)
|
|
- When linking to a Slack thread, you might want to share details of the conclusion
|
|
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
|
|
- Add review comments if necessary to explain to the reviewer the logic behind a change
|
|
|
|
### What?
|
|
|
|
### Why?
|
|
|
|
### How?
|
|
|
|
Closes NEXT-
|
|
Fixes #
|
|
|
|
-->
|