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

feat: improve opening a new issue flow #34434

Merged
merged 11 commits into from Feb 16, 2022
Merged

Conversation

balazsorban44
Copy link
Member

@balazsorban44 balazsorban44 commented Feb 16, 2022

Ref: Slack thread

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

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

errors/opening-an-issue.md Outdated Show resolved Hide resolved
errors/opening-an-issue.md Outdated Show resolved Hide resolved
errors/opening-an-issue.md Outdated Show resolved Hide resolved
errors/opening-an-issue.md Outdated Show resolved Hide resolved
@ijjk

This comment has been minimized.

@ijjk
Copy link
Member

ijjk commented Feb 16, 2022

Failing test suites

Commit: a5eb321

yarn testheadless test/production/next/jest/index.test.ts

  • next/jest > should work
Expand output

● next/jest › should work

thrown: "Exceeded timeout of 90000 ms for a hook.
Use jest.setTimeout(newTimeout) to increase the timeout value, if this is a long-running test."

   6 |   let next: NextInstance
   7 |
>  8 |   beforeAll(async () => {
     |   ^
   9 |     next = await createNext({
  10 |       files: {
  11 |         'components/comp.js': `

  at production/next/jest/index.test.ts:8:3
  at Object.<anonymous> (production/next/jest/index.test.ts:5:1)

● Test suite failed to run

TypeError: Cannot read property 'destroy' of undefined

  113 |     })
  114 |   })
> 115 |   afterAll(() => next.destroy())
      |                       ^
  116 |
  117 |   it('should work', async () => {
  118 |     const html = await renderViaHTTP(next.url, '/')

  at production/next/jest/index.test.ts:115:23

Read more about building and testing Next.js in contributing.md.

styfle
styfle previously approved these changes Feb 16, 2022
Copy link
Member

@styfle styfle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 19, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants