Skip to content

Commit

Permalink
docs: add more issue templates (#811)
Browse files Browse the repository at this point in the history
  • Loading branch information
bradzacher authored and JamesHenry committed Aug 19, 2019
1 parent 580eceb commit 656d255
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 1 deletion.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE.md
@@ -0,0 +1,37 @@
---
name: catch-all template
about: Provides some general structure to issues that people choose to log outside the normal flow
title: ''
labels: triage
assignees: ''
---

**What were you trying to do?**

```json
{
"rules": {
"@typescript-eslint/<rule>": ["<setting>"]
}
}
```

```ts
// Put your code here
```

**What did you expect to happen?**

**What actually happened?**

**Versions**

| package | version |
| --------------------------------------- | ------- |
| `@typescript-eslint/eslint-plugin` | `X.Y.Z` |
| `@typescript-eslint/parser` | `X.Y.Z` |
| `@typescript-eslint/typescript-estree` | `X.Y.Z` |
| `@typescript-eslint/experimental-utils` | `X.Y.Z` |
| `TypeScript` | `X.Y.Z` |
| `node` | `X.Y.Z` |
| `npm` | `X.Y.Z` |
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/eslint-plugin-typescript.md
Expand Up @@ -22,7 +22,7 @@ Are you opening an issue because the rule you're trying to use is not found?
1) Check the releases log: https://github.com/typescript-eslint/typescript-eslint/releases
- If the rule isn't listed there, then chances are it hasn't been released to the main npm tag yet.
2) Try installing the `canary` tag: `npm i @typescript-eslint/eslint-plugin@canary`.
- The canary tag is built for every commit to master, so it contains the bleeding edge build.
- The canary tag is built for every commit to master, so it contains the bleeding edge build.
3) If ESLint still can't find the rule, then consider reporting an issue.
-->

Expand Down
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/typescript-eslint-utils.md
@@ -0,0 +1,20 @@
---
name: '@typescript-eslint/experimental-utils'
about: Report an issue with the `@typescript-eslint/experimental-utils` package
title: ''
labels: 'package: utils, triage'
assignees: ''
---

**What did you expect to happen?**

**What actually happened?**

**Versions**

| package | version |
| --------------------------------------- | ------- |
| `@typescript-eslint/experimental-utils` | `X.Y.Z` |
| `TypeScript` | `X.Y.Z` |
| `node` | `X.Y.Z` |
| `npm` | `X.Y.Z` |

0 comments on commit 656d255

Please sign in to comment.