|
| 1 | +name: Bug Report 🪲 |
| 2 | +description: Create a bug report to help us improve |
| 3 | +title: '[Bug]: ' |
| 4 | +labels: ['Bug Report', 'Needs Triage'] |
| 5 | +body: |
| 6 | + - type: markdown |
| 7 | + attributes: |
| 8 | + value: | |
| 9 | + # Please follow these steps first: |
| 10 | + - type: markdown |
| 11 | + attributes: |
| 12 | + value: | |
| 13 | + ## Troubleshoot |
| 14 | + 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. |
| 15 | + - type: markdown |
| 16 | + attributes: |
| 17 | + value: | |
| 18 | + ## Ask for help through appropriate channels |
| 19 | + 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. |
| 20 | + - type: markdown |
| 21 | + attributes: |
| 22 | + value: | |
| 23 | + ## Verify transformations |
| 24 | + 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). |
| 25 | + - type: markdown |
| 26 | + attributes: |
| 27 | + value: | |
| 28 | + ## Make a minimal reproduction |
| 29 | + 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? |
| 30 | +
|
| 31 | + The simpler you can make it, the more likely we are to successfully verify and fix the bug. |
| 32 | + - type: markdown |
| 33 | + attributes: |
| 34 | + value: | |
| 35 | + :bangbang: Bug reports without a minimal reproduction will be rejected. :bangbang: |
| 36 | +
|
| 37 | + --- |
| 38 | + - type: input |
| 39 | + id: version |
| 40 | + attributes: |
| 41 | + label: Version |
| 42 | + description: | |
| 43 | + The version of Jest you are using. |
| 44 | + Is it the [latest](https://github.com/facebook/jest/releases)? Test and see if the bug has already been fixed. |
| 45 | + placeholder: ex. 27.0.6 |
| 46 | + validations: |
| 47 | + required: true |
| 48 | + - type: textarea |
| 49 | + id: reproduction |
| 50 | + attributes: |
| 51 | + label: Steps to reproduce |
| 52 | + description: Please link to a repository with a minimal reproduction and describe accurately how we can reproduce/verify the bug. |
| 53 | + placeholder: | |
| 54 | + Example steps (replace with your own): |
| 55 | + 1. Clone my repo at https://github.com/<myuser>/example |
| 56 | + 2. yarn install |
| 57 | + 3. yarn test |
| 58 | + 4. You should see the error come up |
| 59 | + validations: |
| 60 | + required: true |
| 61 | + - type: textarea |
| 62 | + id: expected |
| 63 | + attributes: |
| 64 | + label: Expected behavior |
| 65 | + description: A description of what you expect to happen. |
| 66 | + placeholder: I expect to see X or Y |
| 67 | + validations: |
| 68 | + required: true |
| 69 | + - type: textarea |
| 70 | + id: what-happened |
| 71 | + attributes: |
| 72 | + label: Actual behavior |
| 73 | + description: A clear and concise description of the unexpected behavior. |
| 74 | + placeholder: A bug happened! |
| 75 | + validations: |
| 76 | + required: true |
| 77 | + - type: textarea |
| 78 | + id: context |
| 79 | + attributes: |
| 80 | + label: Additional context |
| 81 | + description: Anything else that might be relevant |
| 82 | + validations: |
| 83 | + required: false |
| 84 | + - type: textarea |
| 85 | + id: envinfo |
| 86 | + attributes: |
| 87 | + label: Environment |
| 88 | + description: | |
| 89 | + Please paste the output of running `npx envinfo --preset jest`. |
| 90 | + This will be automatically formatted as a code block, so no need for backticks. |
| 91 | + placeholder: | |
| 92 | + System: |
| 93 | + OS: Linux 5.10 Debian GNU/Linux 9 (stretch) |
| 94 | + CPU: (8) arm64 |
| 95 | + Binaries: |
| 96 | + Node: 14.17.0 - /usr/local/bin/node |
| 97 | + Yarn: 1.22.5 - /usr/local/bin/yarn |
| 98 | + npm: 6.14.13 - /usr/local/bin/npm |
| 99 | + npmPackages: |
| 100 | + jest: 27.0.6 => 27.0.6 |
| 101 | + render: shell |
| 102 | + validations: |
| 103 | + required: true |
0 commit comments