Skip to content

Commit a28fceb

Browse files
RyanCavanaughRyanCavanaugh
authored
Update issue templates (microsoft#34767)
* Update issue templates * Add config.yml
1 parent 72b7a65 commit a28fceb

File tree

4 files changed

+116
-101
lines changed

4 files changed

+116
-101
lines changed

‎.github/ISSUE_TEMPLATE/Bug_report.md

Lines changed: 44 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,44 @@
1-
---
2-
name: Bug report
3-
about: Create a report to help us improve
4-
5-
---
6-
7-
<!-- 🚨 STOP 🚨 𝗦𝗧𝗢𝗣 🚨 𝑺𝑻𝑶𝑷 🚨
8-
9-
Half of all issues filed here are duplicates, answered in the FAQ, or not appropriate for the bug tracker. Even if you think you've found a *bug*, please read the FAQ first, especially the Common "Bugs" That Aren't Bugs section!
10-
11-
Please help us by doing the following steps before logging an issue:
12-
* Search: https://github.com/Microsoft/TypeScript/search?type=Issues
13-
* Read the FAQ: https://github.com/Microsoft/TypeScript/wiki/FAQ
14-
15-
Please fill in the *entire* template below.
16-
-->
17-
18-
<!--
19-
Please try to reproduce the issue with the latest published version. It may have already been fixed.
20-
For npm: `typescript@next`
21-
This is also the 'Nightly' version in the playground: http://www.typescriptlang.org/play/?ts=Nightly
22-
-->
23-
**TypeScript Version:** 3.7.x-dev.201xxxxx
24-
25-
<!-- Search terms you tried before logging this (so others can find this issue more easily) -->
26-
**Search Terms:**
27-
28-
**Code**
29-
30-
```ts
31-
// A *self-contained* demonstration of the problem follows...
32-
// Test this by running `tsc` on the command-line, rather than through another build tool such as Gulp, Webpack, etc.
33-
```
34-
35-
**Expected behavior:**
36-
37-
**Actual behavior:**
38-
39-
**Playground Link:** <!-- A link to a TypeScript Playground "Share" link which demonstrates this behavior -->
40-
41-
**Related Issues:** <!-- Did you find other bugs that looked similar? -->
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!-- 🚨 STOP 🚨 𝗦𝗧𝗢𝗣 🚨 𝑺𝑻𝑶𝑷 🚨
11+
12+
Half of all issues filed here are duplicates, answered in the FAQ, or not appropriate for the bug tracker. Even if you think you've found a *bug*, please read the FAQ first, especially the Common "Bugs" That Aren't Bugs section!
13+
14+
Please help us by doing the following steps before logging an issue:
15+
* Search: https://github.com/Microsoft/TypeScript/search?type=Issues
16+
* Read the FAQ: https://github.com/Microsoft/TypeScript/wiki/FAQ
17+
18+
Please fill in the *entire* template below.
19+
-->
20+
21+
<!--
22+
Please try to reproduce the issue with the latest published version. It may have already been fixed.
23+
For npm: `typescript@next`
24+
This is also the 'Nightly' version in the playground: http://www.typescriptlang.org/play/?ts=Nightly
25+
-->
26+
**TypeScript Version:** 3.7.x-dev.201xxxxx
27+
28+
<!-- Search terms you tried before logging this (so others can find this issue more easily) -->
29+
**Search Terms:**
30+
31+
**Code**
32+
33+
```ts
34+
// A *self-contained* demonstration of the problem follows...
35+
// Test this by running `tsc` on the command-line, rather than through another build tool such as Gulp, Webpack, etc.
36+
```
37+
38+
**Expected behavior:**
39+
40+
**Actual behavior:**
41+
42+
**Playground Link:** <!-- A link to a TypeScript Playground "Share" link which demonstrates this behavior -->
43+
44+
**Related Issues:** <!-- Did you find other bugs that looked similar? -->

‎.github/ISSUE_TEMPLATE/Feature_request.md

Lines changed: 47 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,47 @@
1-
---
2-
name: Feature request
3-
about: Suggest an idea for this project
4-
5-
---
6-
7-
<!-- 🚨 STOP 🚨 𝗦𝗧𝗢𝗣 🚨 𝑺𝑻𝑶𝑷 🚨
8-
9-
Half of all issues filed here are duplicates, answered in the FAQ, or not appropriate for the bug tracker.
10-
11-
Please help us by doing the following steps before logging an issue:
12-
* Search: https://github.com/Microsoft/TypeScript/search?type=Issues
13-
* Read the FAQ, especially the "Common Feature Requests" section: https://github.com/Microsoft/TypeScript/wiki/FAQ
14-
15-
-->
16-
17-
## Search Terms
18-
19-
<!-- List of keywords you searched for before creating this issue. Write them down here so that others can find this suggestion more easily -->
20-
21-
## Suggestion
22-
23-
<!-- A summary of what you'd like to see added or changed -->
24-
25-
## Use Cases
26-
27-
<!--
28-
What do you want to use this for?
29-
What shortcomings exist with current approaches?
30-
-->
31-
32-
## Examples
33-
34-
<!-- Show how this would be used and what the behavior would be -->
35-
36-
## Checklist
37-
38-
My suggestion meets these guidelines:
39-
40-
* [ ] This wouldn't be a breaking change in existing TypeScript/JavaScript code
41-
* [ ] This wouldn't change the runtime behavior of existing JavaScript code
42-
* [ ] This could be implemented without emitting different JS based on the types of the expressions
43-
* [ ] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
44-
* [ ] This feature would agree with the rest of [TypeScript's Design Goals](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals).
45-
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!-- 🚨 STOP 🚨 𝗦𝗧𝗢𝗣 🚨 𝑺𝑻𝑶𝑷 🚨
11+
12+
Half of all issues filed here are duplicates, answered in the FAQ, or not appropriate for the bug tracker.
13+
14+
Please help us by doing the following steps before logging an issue:
15+
* Search: https://github.com/Microsoft/TypeScript/search?type=Issues
16+
* Read the FAQ, especially the "Common Feature Requests" section: https://github.com/Microsoft/TypeScript/wiki/FAQ
17+
18+
-->
19+
20+
## Search Terms
21+
22+
<!-- List of keywords you searched for before creating this issue. Write them down here so that others can find this suggestion more easily -->
23+
24+
## Suggestion
25+
26+
<!-- A summary of what you'd like to see added or changed -->
27+
28+
## Use Cases
29+
30+
<!--
31+
What do you want to use this for?
32+
What shortcomings exist with current approaches?
33+
-->
34+
35+
## Examples
36+
37+
<!-- Show how this would be used and what the behavior would be -->
38+
39+
## Checklist
40+
41+
My suggestion meets these guidelines:
42+
43+
* [ ] This wouldn't be a breaking change in existing TypeScript/JavaScript code
44+
* [ ] This wouldn't change the runtime behavior of existing JavaScript code
45+
* [ ] This could be implemented without emitting different JS based on the types of the expressions
46+
* [ ] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
47+
* [ ] This feature would agree with the rest of [TypeScript's Design Goals](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals).

‎.github/ISSUE_TEMPLATE/Question.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
1-
---
2-
name: Question
3-
about: The issue tracker is not for questions. Please use Stack Overflow or other resources for help writing TypeScript code.
4-
5-
---
6-
7-
THE ISSUE TRACKER IS NOT FOR QUESTIONS.
8-
9-
DO NOT CREATE A NEW ISSUE TO ASK A QUESTION.
10-
11-
IF YOU ARE HAVING PROBLEMS WITH YOUR TYPESCRIPT CODE, DO NOT ASK A QUESTION HERE.
12-
13-
Tens of thousands of TypeScript questions have been asked and answered on StackOverflow; see https://stackoverflow.com/questions/tagged/typescript . You can ask questions there or on other websites.
14-
15-
The only exception is if you have a question about *the TypeScript compiler API itself*. Please post a complete example of what you're trying to do and precisely describe what your question is.
1+
---
2+
name: Question
3+
about: The issue tracker is not for questions. Please use Stack Overflow or other
4+
resources for help writing TypeScript code.
5+
title: ''
6+
labels: Question
7+
assignees: ''
8+
9+
---
10+
11+
THE ISSUE TRACKER IS NOT FOR QUESTIONS.
12+
13+
IF YOU ARE HAVING PROBLEMS WITH YOUR TYPESCRIPT CODE, DO NOT ASK A QUESTION HERE.
14+
15+
Tens of thousands of TypeScript questions have been asked and answered on StackOverflow; see https://stackoverflow.com/questions/tagged/typescript . You can ask questions there or on other websites.
16+
17+
The only exception is if you have a question about *the TypeScript compiler API itself*. Please post a complete example of what you're trying to do and precisely describe what your question is.

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Stack Overflow
4+
url: https://stackoverflow.com/questions/tagged/typescript
5+
about: Please ask and answer questions here.
6+
- name: TypeScript FAQ
7+
url: https://github.com/microsoft/TypeScript/wiki/FAQ
8+
about: Please check the FAQ before filing new issues

0 commit comments

Comments
 (0)