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

chore: replace issue templates with forms #11772

Merged
merged 3 commits into from Aug 24, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
39 changes: 0 additions & 39 deletions .github/ISSUE_TEMPLATE/bug.md

This file was deleted.

103 changes: 103 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
@@ -0,0 +1,103 @@
name: Bug Report 🪲
description: Create a bug report to help us improve
title: '[Bug]: '
labels: ['Bug Report', 'Needs Triage']
body:
- type: markdown
attributes:
value: |
# Please follow these steps first:
- type: markdown
attributes:
value: |
## Troubleshoot
If Jest is not behaving the way you expect, we'd ask you to look at the [documentation](https://jestjs.io/docs/getting-started) and search the issue tracker for evidence supporting your expectation. Please make reasonable efforts to troubleshoot and rule out issues with your code, the configuration, or any 3rd party libraries you might be using.
- type: markdown
attributes:
value: |
## Ask for help through appropriate channels
If you feel unsure about the cause of the problem, consider asking for help on for example [StackOverflow](https://stackoverflow.com/questions/ask) or our [Discord channel](https://discord.gg/j6FKKQQrW9) before posting a bug report. The issue tracker is not a help forum.
- type: markdown
attributes:
value: |
## Verify transformations
It's important to understand that Jest runs the code in your project as JavaScript. If you use syntax not supported by Node.js out of the box - such as React JSX, types from TypeScript, or components from Angular or Vue - that code needs to be [transformed](https://jestjs.io/docs/code-transformation) into plain JavaScript (similar to what you would do when building for browsers). Jest supports this via the [`transform` configuration option](https://jestjs.io/docs/configuration#transform-objectstring-pathtotransformer--pathtotransformer-object).
- type: markdown
attributes:
value: |
## Make a minimal reproduction
To file the report, you will need a GitHub repository with a minimal (but complete) example and simple/clear steps on how to reproduce the bug. If all your tests fail with a strange error, can you find a way to show us with just one? If you have many configuration options in your `jest.config.js`, can you simplify it?

The simpler you can make it, the more likely we are to successfully verify and fix the bug.
- type: markdown
attributes:
value: |
:bangbang:   Bug reports without a minimal reproduction will be rejected. :bangbang:

---
- type: input
id: version
attributes:
label: Version
description: |
The version of Jest you are using.
Is it the [latest](https://github.com/facebook/jest/releases)? Test and see if the bug has already been fixed.
placeholder: ex. 27.0.6
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Steps to reproduce
description: Please link to a repository with a minimal reproduction and describe accurately how we can reproduce/verify the bug.
placeholder: |
Example steps (replace with your own):
1. Clone my repo at https://github.com/<myuser>/example
2. yarn install
3. yarn test
4. You should see the error come up
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behavior
description: A description of what you expect to happen.
placeholder: I expect to see X or Y
validations:
required: true
- type: textarea
id: what-happened
attributes:
label: Actual behavior
description: A clear and concise description of the unexpected behavior.
placeholder: A bug happened!
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional context
description: Anything else that might be relevant
validations:
required: false
- type: textarea
id: envinfo
attributes:
label: Environment
description: |
Please paste the output of running `npx envinfo --preset jest`.
This will be automatically formatted as a code block, so no need for backticks.
placeholder: |
System:
OS: Linux 5.10 Debian GNU/Linux 9 (stretch)
CPU: (8) arm64
Binaries:
Node: 14.17.0 - /usr/local/bin/node
Yarn: 1.22.5 - /usr/local/bin/yarn
npm: 6.14.13 - /usr/local/bin/npm
npmPackages:
jest: 27.0.6 => 27.0.6
render: shell
validations:
required: true
29 changes: 0 additions & 29 deletions .github/ISSUE_TEMPLATE/feature.md

This file was deleted.

46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
@@ -0,0 +1,46 @@
name: Feature Proposal 🚀
description: Submit a proposal for a new feature
title: '[Feature]: '
labels: ['🚀 Feature Request']
body:
- type: markdown
attributes:
value: |
### Thank you for taking the time to suggest a new feature!
- type: textarea
id: description
attributes:
label: '🚀 Feature Proposal'
description: A clear and concise description of what the feature is.
validations:
required: true
- type: textarea
id: solution
attributes:
label: Motivation
description: Outline your motivation for the proposal. How will it make Jest better?
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Example
description: Describe how this feature would be used.
validations:
required: false
- type: textarea
id: extra
attributes:
label: Pitch
description: |
Why does this feature belong in the [Jest core platform](https://www.youtube.com/watch?v=NtjyeojAOBs)?
validations:
required: true
- type: markdown
attributes:
value: |
Common proposals that do not typically make it to core:

- New matchers (see [jest-extended](https://github.com/jest-community/jest-extended))
- Changes to the default reporter (use custom reporters instead)
- Changes to node/jsdom test environments (use custom environments instead)
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/question.md

This file was deleted.

27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
@@ -0,0 +1,27 @@
name: 'Questions / Help 💬'
description: If you have questions, please check Reactiflux or StackOverflow
title: '[Please read the message below]'
labels: ['💬 Question']
body:
- type: markdown
attributes:
value: |
## Questions and Help 💬

This issue tracker is reserved for bug reports and feature proposals.

For anything else, such as questions or getting help, please see:

- [The Jest help page](https://jestjs.io/help)
- [Our `#testing` channel in Reactiflux](https://discord.gg/j6FKKQQrW9)
- The [jestjs](https://stackoverflow.com/questions/tagged/jestjs) tag on [StackOverflow](https://stackoverflow.com/questions/ask)
- type: checkboxes
id: no-post
attributes:
label: |
Please do not submit this issue.
description: |
:bangbang: &nbsp; This issue will be closed. :bangbang:
options:
- label: I understand
required: true
41 changes: 0 additions & 41 deletions .github/ISSUE_TEMPLATE/regression.md

This file was deleted.