From a28fcebff2ef93b985cbc1cb6967f47f2411e149 Mon Sep 17 00:00:00 2001 From: Ryan Cavanaugh Date: Mon, 28 Oct 2019 11:12:20 -0700 Subject: [PATCH] Update issue templates (#34767) * Update issue templates * Add config.yml --- .github/ISSUE_TEMPLATE/Bug_report.md | 85 +++++++++++---------- .github/ISSUE_TEMPLATE/Feature_request.md | 92 ++++++++++++----------- .github/ISSUE_TEMPLATE/Question.md | 32 ++++---- .github/ISSUE_TEMPLATE/config.yml | 8 ++ 4 files changed, 116 insertions(+), 101 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index 62647a8b163..fe61f3d35e7 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -1,41 +1,44 @@ ---- -name: Bug report -about: Create a report to help us improve - ---- - - - - -**TypeScript Version:** 3.7.x-dev.201xxxxx - - -**Search Terms:** - -**Code** - -```ts -// A *self-contained* demonstration of the problem follows... -// Test this by running `tsc` on the command-line, rather than through another build tool such as Gulp, Webpack, etc. -``` - -**Expected behavior:** - -**Actual behavior:** - -**Playground Link:** - -**Related Issues:** +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + + + + +**TypeScript Version:** 3.7.x-dev.201xxxxx + + +**Search Terms:** + +**Code** + +```ts +// A *self-contained* demonstration of the problem follows... +// Test this by running `tsc` on the command-line, rather than through another build tool such as Gulp, Webpack, etc. +``` + +**Expected behavior:** + +**Actual behavior:** + +**Playground Link:** + +**Related Issues:** diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md index 74525bf2f80..0ef996b5579 100644 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -1,45 +1,47 @@ ---- -name: Feature request -about: Suggest an idea for this project - ---- - - - -## Search Terms - - - -## Suggestion - - - -## Use Cases - - - -## Examples - - - -## Checklist - -My suggestion meets these guidelines: - -* [ ] This wouldn't be a breaking change in existing TypeScript/JavaScript code -* [ ] This wouldn't change the runtime behavior of existing JavaScript code -* [ ] This could be implemented without emitting different JS based on the types of the expressions -* [ ] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.) -* [ ] This feature would agree with the rest of [TypeScript's Design Goals](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals). - +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + + + +## Search Terms + + + +## Suggestion + + + +## Use Cases + + + +## Examples + + + +## Checklist + +My suggestion meets these guidelines: + +* [ ] This wouldn't be a breaking change in existing TypeScript/JavaScript code +* [ ] This wouldn't change the runtime behavior of existing JavaScript code +* [ ] This could be implemented without emitting different JS based on the types of the expressions +* [ ] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.) +* [ ] This feature would agree with the rest of [TypeScript's Design Goals](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals). diff --git a/.github/ISSUE_TEMPLATE/Question.md b/.github/ISSUE_TEMPLATE/Question.md index fbb9d150a7c..5b71053ade8 100644 --- a/.github/ISSUE_TEMPLATE/Question.md +++ b/.github/ISSUE_TEMPLATE/Question.md @@ -1,15 +1,17 @@ ---- -name: Question -about: The issue tracker is not for questions. Please use Stack Overflow or other resources for help writing TypeScript code. - ---- - -THE ISSUE TRACKER IS NOT FOR QUESTIONS. - -DO NOT CREATE A NEW ISSUE TO ASK A QUESTION. - -IF YOU ARE HAVING PROBLEMS WITH YOUR TYPESCRIPT CODE, DO NOT ASK A QUESTION HERE. - -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. - -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. +--- +name: Question +about: The issue tracker is not for questions. Please use Stack Overflow or other + resources for help writing TypeScript code. +title: '' +labels: Question +assignees: '' + +--- + +THE ISSUE TRACKER IS NOT FOR QUESTIONS. + +IF YOU ARE HAVING PROBLEMS WITH YOUR TYPESCRIPT CODE, DO NOT ASK A QUESTION HERE. + +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. + +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. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..a28b38e80df --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Stack Overflow + url: https://stackoverflow.com/questions/tagged/typescript + about: Please ask and answer questions here. + - name: TypeScript FAQ + url: https://github.com/microsoft/TypeScript/wiki/FAQ + about: Please check the FAQ before filing new issues \ No newline at end of file