Commit graph

46 commits

Author SHA1 Message Date
Balázs Orbán
4d8436c2b0
chore: add more labels (#65209) 2024-04-30 15:26:06 +00:00
Sam Ko
a673e84aaa
chore(github-templates): update docs_report template, update template descriptions (#65178)
## Why?

- Update **Docs Request for an Update or Improvement** to **Docs
Report**, similar to **Bug Report**
- Update template descriptions

Closes NEXT-3255
2024-04-29 16:10:16 -07:00
Balázs Orbán
6a9a392059
chore: update labels in workflows/templates (#63713) 2024-04-17 14:28:51 +02:00
Balázs Orbán
dc109bf6c9
chore: indicate staleness more prominently in next info output (#60376)
### What?

Improve the `next info` output.

<details>
<summary>Before:
</summary>
<img
src="https://github.com/vercel/next.js/assets/18369201/735da72f-6746-42a0-838d-e10db78b2db3">
</details>

<details>
<summary>After:
</summary>
<img
src="https://github.com/vercel/next.js/assets/18369201/d72c0027-71d9-494c-bb98-dd0fed99c8d9">
</details>

### Why?

People have been ignoring the ask to check `next@canary` before opening
a new issue, which results in triaging overhead. This PR inlines the
warning into `next info` that would make it an extra effort to remove
the warning without reading the message, hopefully leading to not
ignoring the message anymore.

### How?

Reusing the same logic from the version staleness indicator from Error
Overlay.

[Slack
thread](https://vercel.slack.com/archives/C03KAR5DCKC/p1704364764719949)
2024-01-19 18:36:19 +01:00
Sam Ko
5acf751663
chore: include required Next.js stages to issue template (#60142)
Include an additional requirement in the [Issue
Template](https://github.com/vercel/next.js/blob/canary/.github/ISSUE_TEMPLATE/1.bug_report.yml)
for adding information about which :nextjs: stage (e.g, `next dev`,
`next build`, & `next start`) is affected in an issue.
2024-01-02 15:03:19 -08:00
Jiachi Liu
65d59a2422
chore: add github bug report item type module resolution (#60121)
Add new bug report type of module resolution in GH yml config file

Closes NEXT-1946
2024-01-02 11:44:05 -08:00
Balázs Orbán
c6c3891688
chore: remove replay from issue template (#55397)
### What?

Removes Replay.io as a valid reproduction link from our bug template.

### Why?

Based on issues https://github.com/vercel/next.js/issues/55181 and https://github.com/vercel/next.js/issues/55278 it looks like people are struggling to report the correct thing. Also, without source maps, replays are still harder to use for debugging than an actual code base

Ref: [Slack thread](https://vercel.slack.com/archives/C04DUD7EB1B/p1694608481515339?thread_ts=1694428848.689079&cid=C04DUD7EB1B)
2023-09-18 17:05:19 +00:00
Balázs Orbán
9adc7910a2
chore: update bug report template (#54824)
### What?

Follow-up of #54724

- Removed/merged some sections
- Added placeholders to hint the user what the input should be
- Reorganized the sections in terms of importance
- Made all sections but one required (we should not ask irrelevant questions to simplify the reporting process)
- Added a small guide on how to pinpoint an exact version of Next.js introducing a bug

### Why?

Clarifying the fact that a missing/invalid reproduction will result in the issue being closed to avoid confusion

[Slack thread](https://vercel.slack.com/archives/C04DUD7EB1B/p1693321920087959)

### How?

Compare the rendered issue templates:
- Before: https://github.com/vercel/next.js/issues/new?assignees=&labels=template%3A+bug&projects=&template=1.bug_report.yml
- After: https://github.com/balazsorban44/next.js/issues/new?assignees=&labels=template%3A+bug&projects=&template=1.bug_report.yml
- Autoclosing still works: https://github.com/balazsorban44/next.js/issues/52
2023-09-01 17:37:17 +00:00
Balázs Orbán
ca96578f0b
chore: update bug repro links (#53550)
### What?

Follow-up of #53453

### Why?

Forgot to update the link in a few places

---------

Co-authored-by: Zack Tanner <zacktanner@gmail.com>
Co-authored-by: JJ Kasper <jj@jjsweb.site>
2023-08-03 16:18:26 -07:00
Jiachi Liu
0048908078
Remove legacy head.js in examples (#52292)
* Remove legacy `head.js` from examples and use `metadata` exports
instead
* Update the report template

---------
2023-07-05 16:42:36 -07:00
Steven
e27832665a
chore: update issue template option to "App Router" (#52287)
https://nextjs.org/docs/app
2023-07-05 22:56:43 +00:00
JJ Kasper
9b0af737b8
Suggest a replay in the bug issue template (#50022)
x-ref: [slack
thread](https://vercel.slack.com/archives/C04DUD7EB1B/p1684457147422049)
2023-05-18 19:54:15 -07:00
Balázs Orbán
8d9658c680
chore: simplify repo templates (#49073)
[Slack
thread](https://vercel.slack.com/archives/C04DUD7EB1B/p1682414178536089)

Closes NEXT-1076
2023-05-03 14:42:31 +02:00
Balázs Orbán
9d5a3e8c6b
chore: update labels (#47904)
### What?

Syncing https://github.com/vercel/next.js/labels with the bug report template.

### Why?

We've got some OS-related reports so it would be nice to be able to filter on that.

### How?

The label description is added as a select option to the template, which then matches one of the labels https://github.com/vercel/next.js/labels
2023-04-04 11:30:56 +00:00
Steven
af49d5098b
chore(docs): update next export to output: 'export' (#47717)
fix NEXT-927 ([link](https://linear.app/vercel/issue/NEXT-927))
2023-03-31 02:04:23 +00:00
Timon Jurschitsch
49e8f2bbbf
Add instructions to bug issue template (#47090)
Hi everyone! Thank you for your work on this awesome framework 🙌 
This short PR will add a short description on how to install the `canary` version of `next` to the `bug issue template`. It's only affecting this issue template and nothing else.

Closes #47080 

Co-authored-by: Steven <229881+styfle@users.noreply.github.com>
2023-03-13 21:02:21 +00:00
Balázs Orbán
a88b0335b6
chore: add App Router template to bug report (#46872)
### What?

Link to
https://github.com/vercel/next.js/tree/canary/examples/reproduction-template-app-dir
from our bug report template.

### Why?

To lower the barrier to adding a reproduction even when reporting an App
Router-related issue, which is currently behind a flag. (Pointed out in
#46852)

### How?

Added a link in the issue template. The remaining question is, should we
add anything else to
https://github.com/vercel/next.js/tree/canary/examples/reproduction-template-app-dir
to make creating a reproduction easier?

Closes NEXT-789
Related #46852
2023-03-07 13:23:38 +01:00
Balázs Orbán
16a0e5af32
chore: improve repo templates (#46629)
## What?

- Rendering `next info` output as code in the bug template
- Removed the "Feature Request" issue template, in favor of a more
granular discussion template
- Added a minimal template for Help discussions

## Why?

The main part of this PR is the new Feature Request template.

Anyone can propose a change to Next.js. However adding new features
often requires community discussions - whether to align expectations,
understand the consequences (eg.: backward compatibility/lifetime of a
feature), to look at and understand historical reasons for the current
behavior or lack of the feature -, which [GitHub
discussions](https://github.com/vercel/next.js/discussions) is more
suited for than issues.

## How?

- Utilizing the new discussion templates
https://docs.github.com/en/discussions/managing-discussions-for-your-community/creating-discussion-category-forms
- Adding a link to the [new
issue](https://github.com/vercel/next.js/issues/new/choose) view to make
it easier to discover

[Slack
thread](https://vercel.slack.com/archives/C04DUD7EB1B/p1670874727319809)

Closes NEXT-742

---------
2023-03-01 09:25:51 -08:00
Balázs Orbán
8456a51a66
chore: update issue-labeler (#45706) 2023-02-08 14:41:48 +00:00
Jan Kaifer
cefb30b32b
Update codesandbox link in issue template (#44995)
We want reproductions to use the new and better code sandbox.
2023-01-18 12:21:10 +01:00
Jan Kaifer
efe1742668
Update bug report template to make it clear we require repro (#43735)
Co-authored-by: Steven <steven@ceriously.com>
2022-12-06 15:07:35 +01:00
Alfred Mountfield
324de6bf7a
Fix typos in 1.bug_report.yml (#43697)
Found some tiny typos when using the bug template.

## Documentation / Examples

- [x] Make sure the linting passes by running `pnpm build && pnpm lint`
- [x] The "examples guidelines" are followed from [our contributing
doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md)
2022-12-04 13:35:10 -08:00
Balázs Orbán
4ee933db92
chore: add issue labeler (#43599)
Follow-up of #43228. This PR adds a new [GitHub Action](https://github.com/github/issue-labeler) that matches the
issue's body for the [dropdown list items](6cacd5a7c4/.github/ISSUE_TEMPLATE/1.bug_report.yml (L26-L48)) and adds the relevant labels to the issue for triaging automatically.
2022-12-01 12:00:42 +00:00
Balázs Orbán
ef20244851
chore: add area dropdown to bug report template (#43228)
Co-authored-by: Steven <steven@ceriously.com>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2022-11-29 19:34:15 +01:00
Balázs Orbán
fa916e4e67
chore: encourage adding reproductions to issues (#42667)
Issues being reported without a reproduction take longer to
triage/resolve. To make the process faster, we should encourage people
always to add one.

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have a 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 a helpful link attached, see `contributing.md`

## Documentation / Examples

- [ ] Make sure the linting passes by running `pnpm build && pnpm lint`
- [ ] The "examples guidelines" are followed from [our contributing
doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md)
2022-11-08 17:44:25 -08:00
Koen Punt
bad43cf0d6
fix example command in issue template for create-next-app (#41803)
<!--
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 that you're making:
-->

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have a 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 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/examples/adding-examples.md)

Co-authored-by: Steven <steven@ceriously.com>
2022-10-26 01:17:04 -07:00
Balázs Orbán
2cafe367ac chore: clarify issue template for examples 2022-10-20 17:03:31 +02:00
Balázs Orbán
b8c61a9c27
chore: detect no canary verification (#37788)
When triaging bug reports, we would like to make sure that our main focus is on unresolved issues. Next.js is a highly active project, and we cut new releases fairly often, under the `next@canary` tag. Some of the issues being reported might have already been fixed there, so we would like to encourage people to check them out. Once a fix is in `canary`, it will be included in the next `latest` release automatically.

## 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)
2022-06-22 14:54:11 +00:00
JJ Kasper
6ca1de80cd
Add bug report field to issue template (#37766) 2022-06-16 16:20:34 -05:00
Balázs Orbán
86aac3fa3d
Update 1.bug_report.yml 2022-02-16 21:49:31 +01:00
Balázs Orbán
d88793d973
feat: improve opening a new issue flow (#34434)
Ref: [Slack thread](https://vercel.slack.com/archives/CGU8HUTUH/p1645003443213449)

When opening a new issue, it is desired that the user has checked if the `canary` release not already have fixed their issue, since we do not backport fixes to previous Next.js versions.

- added a CLI warning when `next info` runs that looks like this:

![image](https://user-images.githubusercontent.com/18369201/154309275-01ccc979-01e5-4ccb-8a22-5deab64765a0.png)

This links to a message docs page with more information and some useful links.

- refactored our bug report templates to be more clear and removed the fields that are now unnecessary (since running `next info` is expected to run on releases that already have it)

- Made browser/deployment optional, as in most cases those fields are irrelevant. We still ask them, but mention that they are only needed if relevant.

- Asking for the exact browser version now

## 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 `yarn lint`


Co-authored-by: JJ Kasper <22380829+ijjk@users.noreply.github.com>
2022-02-16 17:45:01 +00:00
Balázs Orbán
3ad2035ae6
feat(cli): introduce next info CLI command (#32972)
This PR adds a new command to the `next` CLI.

Running `next info` will print useful information to the terminal about how/where Next.js is run. This information can be added to the Bug report when opening an issue in the repository.

This makes reporting issues more accurate and doesn't require the user to guess certain details, the command will retrieve it on their behalf.

Example output:

```sh
$ npx --no-install next info

    Operating System:
      Platform: linux
      Version: #22-Ubuntu SMP Fri Nov 5 13:21:36 UTC 2021
    Binaries:
      Node: 16.13.0
      npm: 8.1.0
      Yarn: 1.22.17
      pnpm: 6.24.2
    Relevant packages:
      next: 12.0.8-canary.14
      react: 17.0.2
      react-dom: 17.0.2


```

The idea is based on #32858

## Bug

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

## Feature

- [x] 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 `yarn lint`


Co-authored-by: Steven <229881+styfle@users.noreply.github.com>
2022-01-04 15:35:32 +00:00
Tim Neutkens
4aa0ba7f7c
Update 1.bug_report.yml 2021-04-23 16:56:46 +02:00
Tim Neutkens
663d4efef7
Update 1.bug_report.yml 2021-04-20 16:42:28 +02:00
Tim Neutkens
a9132d0fda
Update 1.bug_report.yml 2021-04-20 11:12:29 +02:00
Denise Yu
dd7413d0ea
Fix issue templates (#22349)
This PR fixes the issue templates!

Details: https://gh-community.github.io/issue-template-feedback/changes
2021-02-19 21:38:29 +00:00
Joe Haddad
598997f038
fix: lint 2021-01-15 10:24:16 -05:00
Tim Neutkens
8b02c1ba52
Update 1.bug_report.yml 2021-01-15 11:04:57 +01:00
Tim Neutkens
ad1150d2d1 Run prettier against new issue templates 2021-01-04 13:53:26 +01:00
Tim Neutkens
de752b36a9
Update 1.bug_report.yml 2021-01-04 13:50:06 +01:00
Tim Neutkens
62a1f1b747
Update 1.bug_report.yml 2021-01-04 13:02:06 +01:00
Tim Neutkens
cbb45205a3
Update 1.bug_report.yml 2021-01-04 13:00:57 +01:00
Tim Neutkens
ed78ee8187
Update 1.bug_report.yml 2021-01-04 13:00:29 +01:00
Tim Neutkens
89aab7dd90
Update 1.bug_report.yml 2021-01-04 12:58:25 +01:00
Tim Neutkens
7c55651526
Update 1.bug_report.yml 2021-01-04 12:40:36 +01:00
Tim Neutkens
8085e69ca9
Rename bug_report.yml to 1.bug_report.yml 2021-01-04 12:38:17 +01:00
Renamed from .github/ISSUE_TEMPLATE/bug_report.yml (Browse further)