chore: update issue templates (#2397)

typescript-eslint · Aug 17, 2020 · 6f397df · 6f397df
1 parent b47a3c6
commit 6f397df
Show file tree

Hide file tree

Showing 5 changed files with 111 additions and 39 deletions.
diff --git a/.github/ISSUE_TEMPLATE/eslint-plugin-tslint.md b/.github/ISSUE_TEMPLATE/eslint-plugin-tslint.md
@@ -14,15 +14,24 @@ The more relevant information you can include, the faster we can find the issue
 -->
 
 <!--
-Make sure you read through our FAQ before posting.
-https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md
+🚨 STOP 🚨 𝗦𝗧𝗢𝗣 🚨 𝑺𝑻𝑶𝑷 🚨
+
+This issue template is only for problems specifically with the `@typescript-eslint/eslint-plugin-tslint` package.
+
+If you have a problem with a specific lint rule, please back out and select the `@typescript-eslint/eslint-plugin` template.
 -->
 
+- [ ] I have first restarting my IDE and the issue persists.
+- [ ] I have updated to the latest version of the packages.
+- [ ] I have [read the FAQ](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md) and my problem is not listed.
+
 **Repro**
 
 <!--
 Include a ***minimal*** reproduction case.
 The more irrelevant code/config you give, the harder it is for us to investigate.
+
+Please consider creating an isolated reproduction repo to make it easy for the volunteer maintainers debug your issue.
 -->
 
 ```JSON
@@ -50,8 +59,18 @@ Also include your tslint config, if you're using a separate file.
 
 **Expected Result**
 
+<!--
+What did you expect to happen?
+Please be specific here - list the exact lines and messages you expect.
+-->
+
 **Actual Result**
 
+<!--
+What actually happened?
+Please be specific here - list the exact lines and messages that caused errors
+-->
+
 **Additional Info**
 
 <!--
@@ -70,4 +89,3 @@ i.e. eslint --ext ".ts,.js" src --debug
 | `TypeScript`                              | `X.Y.Z` |
 | `ESLint`                                  | `X.Y.Z` |
 | `node`                                    | `X.Y.Z` |
-| `npm`                                     | `X.Y.Z` |
diff --git a/.github/ISSUE_TEMPLATE/eslint-plugin-typescript.md b/.github/ISSUE_TEMPLATE/eslint-plugin-typescript.md
@@ -26,16 +26,17 @@ Are you opening an issue because the rule you're trying to use is not found?
 3) If ESLint still can't find the rule, then consider reporting an issue.
 -->
 
-<!--
-Make sure you read through our FAQ before posting.
-https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md
--->
+- [ ] I have first restarting my IDE and the issue persists.
+- [ ] I have updated to the latest version of the packages.
+- [ ] I have [read the FAQ](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md) and my problem is not listed.
 
 **Repro**
 
 <!--
 Include a ***minimal*** reproduction case.
 The more irrelevant code/config you give, the harder it is for us to investigate.
+
+Please consider creating an isolated reproduction repo to make it easy for the volunteer maintainers debug your issue.
 -->
 
 ```JSON
@@ -50,10 +51,24 @@ The more irrelevant code/config you give, the harder it is for us to investigate
 // your repro code case
 ```
 
+<!--
+Also include your tsconfig, if you're using type-aware linting
+-->
+
 **Expected Result**
 
+<!--
+What did you expect to happen?
+Please be specific here - list the exact lines and messages you expect.
+-->
+
 **Actual Result**
 
+<!--
+What actually happened?
+Please be specific here - list the exact lines and messages that caused errors
+-->
+
 **Additional Info**
 
 <!--
@@ -72,4 +87,3 @@ i.e. eslint --ext ".ts,.js" src --debug
 | `TypeScript`                       | `X.Y.Z` |
 | `ESLint`                           | `X.Y.Z` |
 | `node`                             | `X.Y.Z` |
-| `npm`                              | `X.Y.Z` |
diff --git a/.github/ISSUE_TEMPLATE/typescript-eslint-parser.md b/.github/ISSUE_TEMPLATE/typescript-eslint-parser.md
@@ -14,15 +14,25 @@ The more relevant information you can include, the faster we can find the issue
 -->
 
 <!--
-Make sure you read through our FAQ before posting.
-https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md
+🚨 STOP 🚨 𝗦𝗧𝗢𝗣 🚨 𝑺𝑻𝑶𝑷 🚨
+
+This issue template is only for problems specifically with the `@typescript-eslint/parser` package.
+That means you should only use this template if there are problems parsing some code.
+
+If you have a problem with a specific lint rule, please back out and select the `@typescript-eslint/eslint-plugin` template.
 -->
 
+- [ ] I have first restarting my IDE and the issue persists.
+- [ ] I have updated to the latest version of the packages.
+- [ ] I have [read the FAQ](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md) and my problem is not listed.
+
 **Repro**
 
 <!--
 Include a ***minimal*** reproduction case.
 The more irrelevant code/config you give, the harder it is for us to investigate.
+
+Please consider creating an isolated reproduction repo to make it easy for the volunteer maintainers debug your issue.
 -->
 
 ```JSON
@@ -40,10 +50,24 @@ The more irrelevant code/config you give, the harder it is for us to investigate
 // your repro code case
 ```
 
+<!--
+Also include your tsconfig, if you're using type-aware linting
+-->
+
 **Expected Result**
 
+<!--
+What did you expect to happen?
+Please be specific here - list the exact lines and messages you expect.
+-->
+
 **Actual Result**
 
+<!--
+What actually happened?
+Please be specific here - list the exact lines and messages that caused errors
+-->
+
 **Additional Info**
 
 <!--
@@ -61,4 +85,3 @@ i.e. eslint --ext ".ts,.js" src --debug
 | `TypeScript`                | `X.Y.Z` |
 | `ESLint`                    | `X.Y.Z` |
 | `node`                      | `X.Y.Z` |
-| `npm`                       | `X.Y.Z` |
diff --git a/.github/ISSUE_TEMPLATE/typescript-eslint-utils.md b/.github/ISSUE_TEMPLATE/typescript-eslint-utils.md
@@ -14,36 +14,45 @@ The more relevant information you can include, the faster we can find the issue
 -->
 
 <!--
-Make sure you read through our FAQ before posting.
-https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md
+🚨 STOP 🚨 𝗦𝗧𝗢𝗣 🚨 𝑺𝑻𝑶𝑷 🚨
+
+This issue template is only for problems specifically with the `@typescript-eslint/experimental-utils` package.
+
+If you have a problem with a specific lint rule, please back out and select the `@typescript-eslint/eslint-plugin` template.
+If you have a problem with the parser, please back out and select the `@typescript-eslint/parser` template.
 -->
 
+- [ ] I have first restarting my IDE and the issue persists.
+- [ ] I have updated to the latest version of the packages.
+- [ ] I have [read the FAQ](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md) and my problem is not listed.
+
 **Repro**
 
 <!--
 Include a ***minimal*** reproduction case.
 The more irrelevant code/config you give, the harder it is for us to investigate.
--->
 
-```JSON
-{
-  "rules": {
-    "@typescript-eslint/<rule>": ["<setting>"]
-  },
-  "parserOptions": {
-    "...": "something"
-  }
-}
-```
+Please consider creating an isolated reproduction repo to make it easy for the volunteer maintainers debug your issue.
+-->
 
 ```TS
 // your repro code case
 ```
 
 **Expected Result**
 
+<!--
+What did you expect to happen?
+Please be specific here - list the exact lines and messages you expect.
+-->
+
 **Actual Result**
 
+<!--
+What actually happened?
+Please be specific here - list the exact lines and messages that caused errors
+-->
+
 **Additional Info**
 
 <!--
@@ -60,4 +69,3 @@ i.e. eslint --ext ".ts,.js" src --debug
 | `@typescript-eslint/experimental-utils` | `X.Y.Z` |
 | `TypeScript`                            | `X.Y.Z` |
 | `node`                                  | `X.Y.Z` |
-| `npm`                                   | `X.Y.Z` |
diff --git a/.github/ISSUE_TEMPLATE/typescript-estree.md b/.github/ISSUE_TEMPLATE/typescript-estree.md
@@ -14,38 +14,48 @@ The more relevant information you can include, the faster we can find the issue
 -->
 
 <!--
-Make sure you read through our FAQ before posting.
-https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md
+🚨 STOP 🚨 𝗦𝗧𝗢𝗣 🚨 𝑺𝑻𝑶𝑷 🚨
+
+This issue template is only for problems specifically with the `@typescript-eslint/typescript-estree` package.
+
+If you have a problem with a specific lint rule, please back out and select the `@typescript-eslint/eslint-plugin` template.
 -->
 
+- [ ] I have first restarting my IDE and the issue persists.
+- [ ] I have updated to the latest version of the packages.
+- [ ] I have [read the FAQ](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md) and my problem is not listed.
+
 **Repro**
 
 <!--
 Include a ***minimal*** reproduction case.
 The more irrelevant code/config you give, the harder it is for us to investigate.
 
-Feel free to omit the eslint config if you are not using this module via ESLint.
+Please consider creating an isolated reproduction repo to make it easy for the volunteer maintainers debug your issue.
 -->
 
-```JSON
-{
-  "rules": {
-    "@typescript-eslint/<rule>": ["<setting>"]
-  },
-  "parserOptions": {
-    "...": "something"
-  }
-}
+```TS
+// the code you're trying to parse
 ```
 
 ```TS
-// your repro code case
+// the code you're using to do the parse of the aforementioned code
 ```
 
 **Expected Result**
 
+<!--
+What did you expect to happen?
+Please be specific here - list the exact lines and messages you expect.
+-->
+
 **Actual Result**
 
+<!--
+What actually happened?
+Please be specific here - list the exact lines and messages that caused errors
+-->
+
 **Additional Info**
 
 <!--
@@ -62,4 +72,3 @@ i.e. eslint --ext ".ts,.js" src --debug
 | `@typescript-eslint/typescript-estree` | `X.Y.Z` |
 | `TypeScript`                           | `X.Y.Z` |
 | `node`                                 | `X.Y.Z` |
-| `npm`                                  | `X.Y.Z` |