Skip to content

Commit

Permalink
Chore: Switch issues to use forms (#15024)
Browse files Browse the repository at this point in the history
* Docs: Switch issues to use forms

* Make title unique

* Add bug report template

* Fix bug report template

* Add rule change template

* New rule template

* Clean up templates

* Update .github/ISSUE_TEMPLATE/bug-report.yml

Co-authored-by: Brandon Mills <[email protected]>

* Update .github/ISSUE_TEMPLATE/change.yml

Co-authored-by: Brandon Mills <[email protected]>

* Update .github/ISSUE_TEMPLATE/new-rule.yml

Co-authored-by: Brandon Mills <[email protected]>

Co-authored-by: Brandon Mills <[email protected]>
  • Loading branch information
nzakas and btmills authored Sep 7, 2021
1 parent f966fe6 commit 143a598
Show file tree
Hide file tree
Showing 8 changed files with 225 additions and 203 deletions.
78 changes: 0 additions & 78 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md

This file was deleted.

35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/CHANGE.md

This file was deleted.

48 changes: 0 additions & 48 deletions .github/ISSUE_TEMPLATE/NEW_RULE.md

This file was deleted.

42 changes: 0 additions & 42 deletions .github/ISSUE_TEMPLATE/RULE_CHANGE.md

This file was deleted.

75 changes: 75 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
name: "\U0001F41E Report a problem"
description: "Report an issue with ESLint or rules bundled with ESLint"
title: "Bug: (fill in)"
labels:
- bug
- "repro:needed"
body:
- type: markdown
attributes:
value: ESLint adheres to the [Open JS Foundation Code of Conduct](https://eslint.org/conduct). By opening an issue, you agree to abide by the code of conduct.
- type: textarea
attributes:
label: Environment
description: |
Please tell us about how you're running ESLint (Run `npx eslint --env-info`.)
value: |
Node version:
npm version:
Local ESLint version:
Global ESLint version:
Operating System:
validations:
required: true
- type: dropdown
attributes:
label: What parser are you using?
description: |
Please keep in mind that some problems are parser-specific.
options:
- "Default (Espree)"
- "@typescript-eslint/parser"
- "@babel/eslint-parser"
- "vue-eslint-parser"
- "@angular-eslint/template-parser"
- Other
validations:
required: true
- type: textarea
attributes:
label: What did you do?
description: |
Please include a *minimal* reproduction case with source code, configuration file, any other information about how you're using ESLint. You can use Markdown in this field.
value: |
<details>
<summary>Configuration</summary>
<!-- Paste your configuration below: -->
```js
```
</details>
render: markdown
validations:
required: true
- type: textarea
attributes:
label: What did you expect to happen?
description: |
You can use Markdown in this field.
render: markdown
validations:
required: true
- type: textarea
attributes:
label: What actually happened?
description: |
Please copy-paste the actual ESLint output. You can use Markdown in this field.
render: markdown
validations:
required: true
- type: checkboxes
attributes:
label: Participation
options:
- label: I am willing to submit a pull request for this issue.
required: false
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/change.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: "\U0001F4DD Request a change (not rule-related)"
description: "Request a change that is not a bug fix, rule change, or new rule"
title: "Change Request: (fill in)"
labels:
- enhancement
- triage
- core
body:
- type: markdown
attributes:
value: ESLint adheres to the [Open JS Foundation Code of Conduct](https://eslint.org/conduct). By opening an issue, you agree to abide by the code of conduct.
- type: input
attributes:
label: ESLint version
description: |
What version of ESLint are you currently using? (Run `npx eslint --version`.)
placeholder: |
e.g. v8.0.0
validations:
required: true
- type: textarea
attributes:
label: What problem do you want to solve?
description: |
Please explain your use case in as much detail as possible.
placeholder: |
ESLint currently...
validations:
required: true
- type: textarea
attributes:
label: What do you think is the correct solution?
description: |
Please explain how you'd like to change ESLint to address the problem.
placeholder: |
I'd like ESLint to...
validations:
required: true
- type: checkboxes
attributes:
label: Participation
options:
- label: I am willing to submit a pull request for this change.
required: false
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/new-rule.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: "\U0001F680 Propose a new core rule"
description: "Propose a new rule to be added to the ESLint core"
title: "New Rule: (fill in)"
labels:
- rule
- feature
body:
- type: markdown
attributes:
value: ESLint adheres to the [Open JS Foundation Code of Conduct](https://eslint.org/conduct). By opening an issue, you agree to abide by the code of conduct.
- type: input
attributes:
label: Rule details
description: What should the new rule do?
validations:
required: true
- type: input
attributes:
label: Related ECMAScript feature
description: What new ECMAScript feature does this rule relate to? Note that we only accept new core rules related to new ECMAScript features.
validations:
required: true
- type: dropdown
attributes:
label: What type of rule is this?
options:
- Warns about a potential problem
- Suggests an alternate way of doing something
- Enforces a formatting/stylistic preference
validations:
required: true
- type: textarea
attributes:
label: Example code
description: Please provide some example JavaScript code that this rule will warn about. This field will render as JavaScript.
render: js
validations:
required: true
- type: textarea
attributes:
label: Why should this rule be in the core instead of a plugin?
description: In general, we prefer that rules be implemented in plugins where they can be tailored to your specific use case.
validations:
required: true
- type: checkboxes
attributes:
label: Participation
options:
- label: I am willing to submit a pull request to implement this rule.
required: false
Loading

0 comments on commit 143a598

Please sign in to comment.