Skip to content

chore: add issue template to propose new rules #3925

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 3, 2021
Merged

chore: add issue template to propose new rules #3925

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b58107
Add template to propose new rules
fregante Sep 25, 2021
ef691f0
Prefill title
fregante Sep 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/eslint-plugin-typescript.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Rule proposal
description: "Propose a new rule for the '@typescript-eslint/eslint-plugin' package"
title: "Rule proposal: "
labels:
- "enhancement: new base rule extension"
- "package: eslint-plugin"
- triage
body:
- type: markdown
attributes:
value: |
Before opening a new issue:
- Look for existing [open or closed rule proposals](https://github.com/typescript-eslint/typescript-eslint/issues?q=label%3A%22enhancement%3A+new+base+rule+extension%22)
- Look for [existing rules](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin)
- Ensure that the rule you want to propose is related to types. If not, consider looking into [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn)
- type: textarea
validations:
required: true
attributes:
label: Description
description: Explain here why this rule would be beneficial
- type: textarea
validations:
required: true
attributes:
label: Fail
description: Specify an example of code that should be detected
value: |
```ts
var replace = 'me';
```
- type: textarea
validations:
required: true
attributes:
label: Pass
description: Specify an example of code that would be accepted in its place
value: |
```ts
const replace = 'me';
```