From 2952d6ed95811ce0971b6855d66fb7a9767a7b72 Mon Sep 17 00:00:00 2001 From: gfyoung Date: Tue, 10 Jan 2023 01:47:23 -0800 Subject: [PATCH] chore: sync templates/*.md files with issue templates (#16758) --- templates/bug-report.md | 23 ++++++++++++++++------- templates/rule-change-proposal.md | 13 +++++++++++-- templates/rule-proposal.md | 11 ++++++----- 3 files changed, 33 insertions(+), 14 deletions(-) diff --git a/templates/bug-report.md b/templates/bug-report.md index c8c552d306d..d7a7a404907 100644 --- a/templates/bug-report.md +++ b/templates/bug-report.md @@ -1,10 +1,19 @@ -**Tell us about your environment:** - -* **ESLint Version:** -* **Node Version:** -* **npm Version:** - -**What parser (default, `@babel/eslint-parser`, `@typescript-eslint/parser`, etc.) are you using?** +**Tell us about your environment (`npx eslint --env-info`):** + +* **Node version:** +* **npm version:** +* **Local ESLint version:** +* **Global ESLint version:** +* **Operating System:** + +**What parser are you using (place an "X" next to just one item)?** + +[ ] `Default (Espree)` +[ ] `@typescript-eslint/parser` +[ ] `@babel/eslint-parser` +[ ] `vue-eslint-parser` +[ ] `@angular-eslint/template-parser` +[ ] `Other` **Please show your full configuration:** diff --git a/templates/rule-change-proposal.md b/templates/rule-change-proposal.md index a4a8e17cbd5..a4d4acb2ad4 100644 --- a/templates/rule-change-proposal.md +++ b/templates/rule-change-proposal.md @@ -1,8 +1,17 @@ **What rule do you want to change?** -**Does this change cause the rule to produce more or fewer warnings?** +**What change do you want to make (place an "X" next to just one item)?** -**How will the change be implemented? (New option, new default behavior, etc.)?** +[ ] Generate more warnings +[ ] Generate fewer warnings +[ ] Implement autofix +[ ] Implement suggestions + +**How will the change be implemented (place an "X" next to just one item)?** + +[ ] A new option +[ ] A new default behavior +[ ] Other **Please provide some example code that this change will affect:** diff --git a/templates/rule-proposal.md b/templates/rule-proposal.md index 2adf9317613..cc1b011361a 100644 --- a/templates/rule-proposal.md +++ b/templates/rule-proposal.md @@ -1,13 +1,14 @@ -**Please describe what the rule should do:** +**What should the new rule do?** + +**What new ECMAScript feature does this rule relate to? Note that we only accept new core rules related to new ECMAScript features.** **What category of rule is this (place an "X" next to just one item)?** -[ ] Enforces code style -[ ] Warns about a potential error +[ ] Warns about a potential problem [ ] Suggests an alternate way of doing something -[ ] Other (please specify:) +[ ] Enforces a formatting/stylistic preference -**Provide 2-3 code examples that this rule will warn about:** +**Please provide some example JavaScript code that this rule will warn about:** ```js