|
| 1 | +name: "Bug report" |
| 2 | +description: "Create a report to help us improve TypeScript" |
| 3 | +body: |
| 4 | + - type: markdown |
| 5 | + attributes: |
| 6 | + value: Please fill in each section completely. Thank you! |
| 7 | + - type: textarea |
| 8 | + id: search_terms |
| 9 | + attributes: |
| 10 | + label: "🔎 Search Terms" |
| 11 | + description: | |
| 12 | + What search terms did you use when trying to find an existing bug report? |
| 13 | +
|
| 14 | + List them here so people in the future can find this one more easily. |
| 15 | + validations: |
| 16 | + required: true |
| 17 | + - type: textarea |
| 18 | + id: version_info |
| 19 | + attributes: |
| 20 | + label: "🕗 Version & Regression Information" |
| 21 | + description: | |
| 22 | + When did you start seeing this bug occur? |
| 23 | +
|
| 24 | + "Bugs" that have existed in TS for a long time are very likely to be FAQs; refer to |
| 25 | + https://github.com/Microsoft/TypeScript/wiki/FAQ#common-bugs-that-arent-bugs |
| 26 | +
|
| 27 | +
|
| 28 | + If possible, please try testing the nightly version of TS to see if it's already been fixed. For npm: `typescript@next` |
| 29 | +
|
| 30 | + This is also the 'Nightly' version in the playground: http://www.typescriptlang.org/play/?ts=Nightly |
| 31 | + |
| 32 | + |
| 33 | + Note: The TypeScript Playground can be used to try older versions of TypeScript. |
| 34 | + |
| 35 | + Please keep and fill in the line that best applies. |
| 36 | + value: | |
| 37 | + - This is a crash |
| 38 | + - This changed between versions ______ and _______ |
| 39 | + - This is the behavior in every version I tried, and I reviewed the FAQ for entries about _________ |
| 40 | + - I was unable to test this on prior versions because _______ |
| 41 | + validations: |
| 42 | + required: true |
| 43 | + - type: input |
| 44 | + id: playground_link |
| 45 | + attributes: |
| 46 | + label: ⏯ Playground Link |
| 47 | + description: | |
| 48 | + A link to a TypeScript Playground "Share" link which shows this behavior. |
| 49 | +
|
| 50 | + This should have the same code as the code snippet below, and use whichever settings are relevant to your report. |
| 51 | +
|
| 52 | +
|
| 53 | + As a last resort, you can link to a repo, but these will be slower for us to investigate. |
| 54 | + placeholder: "Playground link with relevant code: https://www.typescriptlang.org/play?#code/PTAEFkE9QYwewCYFNQHM5IM6gBZIE5JA" |
| 55 | + validations: |
| 56 | + required: false |
| 57 | + - type: textarea |
| 58 | + id: code |
| 59 | + attributes: |
| 60 | + label: 💻 Code |
| 61 | + description: | |
| 62 | + Please post the relevant code sample here as well. |
| 63 | + This code and the Playground code should be the same, do not use separate examples. |
| 64 | +
|
| 65 | + We can quickly address your report if: |
| 66 | +
|
| 67 | + - The code sample is short. Nearly all TypeScript bugs can be demonstrated in 20-30 lines of code! |
| 68 | + - It doesn't use external libraries. These are often issues with the type definitions rather than TypeScript bugs. |
| 69 | + - The incorrectness of the behavior is readily apparent from reading the sample. |
| 70 | +
|
| 71 | + Reports are slower to investigate if: |
| 72 | + - We have to pare too much extraneous code. |
| 73 | + - We have to clone a large repo and validate that the problem isn't elsewhere. |
| 74 | + - The sample is confusing or doesn't clearly demonstrate what's wrong. |
| 75 | + validations: |
| 76 | + required: false |
| 77 | + - type: textarea |
| 78 | + id: actual_behavior |
| 79 | + attributes: |
| 80 | + label: 🙁 Actual behavior |
| 81 | + description: "What happened, and why it was wrong." |
| 82 | + validations: |
| 83 | + required: true |
| 84 | + - type: textarea |
| 85 | + id: expected_behavior |
| 86 | + attributes: |
| 87 | + label: 🙂 Expected behavior |
| 88 | + description: What you expected to happen instead, and why |
| 89 | + validations: |
| 90 | + required: true |
0 commit comments