From 370ed92992e1f3f08bb7e2a85b9eb883f75184e9 Mon Sep 17 00:00:00 2001 From: Christopher Quadflieg Date: Tue, 14 Jul 2020 10:55:36 +0200 Subject: [PATCH 1/9] chore: copy eslint templates --- .github/ISSUE_TEMPLATE/CHANGE.md | 29 +++++++++ .github/ISSUE_TEMPLATE/NEW_RULE.md | 44 +++++++++++++ .github/ISSUE_TEMPLATE/QUESTION.md | 24 +++++++ .github/ISSUE_TEMPLATE/RULE_CHANGE.md | 40 ++++++++++++ .github/ISSUE_TEMPLATE/SECURITY.md | 22 +++++++ .github/ISSUE_TEMPLATE/bug_report.md | 77 +++++++++++++++-------- .github/ISSUE_TEMPLATE/feature_request.md | 16 ----- .github/PULL_REQUEST_TEMPLATE.md | 40 +++++++++++- 8 files changed, 249 insertions(+), 43 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/CHANGE.md create mode 100644 .github/ISSUE_TEMPLATE/NEW_RULE.md create mode 100644 .github/ISSUE_TEMPLATE/QUESTION.md create mode 100644 .github/ISSUE_TEMPLATE/RULE_CHANGE.md create mode 100644 .github/ISSUE_TEMPLATE/SECURITY.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/CHANGE.md b/.github/ISSUE_TEMPLATE/CHANGE.md new file mode 100644 index 000000000..7305c3dc1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/CHANGE.md @@ -0,0 +1,29 @@ +--- +name: "\U0001F4DD Non-rule change request" +about: Request a change that is not a bug fix, rule change, or new rule +title: '' +labels: enhancement, triage, core +assignees: '' +--- + + + +**The version of ESLint you are using.** + +**The problem you want to solve.** + +**Your take on the correct solution to problem.** + +**Are you willing to submit a pull request to implement this change?** diff --git a/.github/ISSUE_TEMPLATE/NEW_RULE.md b/.github/ISSUE_TEMPLATE/NEW_RULE.md new file mode 100644 index 000000000..a8fa4b676 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/NEW_RULE.md @@ -0,0 +1,44 @@ +--- +name: "\U0001F680 New rule proposal" +about: Propose a new rule to be added to ESLint +title: '' +labels: triage, rule, feature +assignees: '' +--- + + + +**Please describe what the rule should do:** + +**What new ECMAScript feature does this rule relate to?** + + + +**What category of rule is this? (place an "X" next to just one item)** + +[ ] Warns about a potential error (problem) +[ ] Suggests an alternate way of doing something (suggestion) +[ ] Other (please specify:) + +**Provide 2-3 code examples that this rule will warn about:** + + + +```js +``` + +**Why should this rule be included in ESLint (instead of a plugin)?** + +**Are you willing to submit a pull request to implement this rule?** diff --git a/.github/ISSUE_TEMPLATE/QUESTION.md b/.github/ISSUE_TEMPLATE/QUESTION.md new file mode 100644 index 000000000..a620ae448 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/QUESTION.md @@ -0,0 +1,24 @@ +--- +name: '⛔ Question' +about: Please go to https://eslint.org/chat +title: '' +labels: '' +assignees: '' +--- + + diff --git a/.github/ISSUE_TEMPLATE/RULE_CHANGE.md b/.github/ISSUE_TEMPLATE/RULE_CHANGE.md new file mode 100644 index 000000000..e64699df1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/RULE_CHANGE.md @@ -0,0 +1,40 @@ +--- +name: "\U0001F4DD Rule change request" +about: Request a change to an existing rule +title: '' +labels: enhancement, triage, rule +assignees: '' +--- + + + +**What rule do you want to change?** + +**Does this change cause the rule to produce more or fewer warnings?** + +**How will the change be implemented? (New option, new default behavior, etc.)?** + +**Please provide some example code that this change will affect:** + + + +```js +``` + +**What does the rule currently do for this code?** + +**What will the rule do after it's changed?** + +**Are you willing to submit a pull request to implement this change?** diff --git a/.github/ISSUE_TEMPLATE/SECURITY.md b/.github/ISSUE_TEMPLATE/SECURITY.md new file mode 100644 index 000000000..319bb404a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/SECURITY.md @@ -0,0 +1,22 @@ +--- +name: '⛔ Security issue' +about: Please file security issues at https://hackerone.com/eslint +title: '' +labels: '' +assignees: '' +--- + + diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 297b12238..bd3bc4af9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,37 +1,64 @@ --- -name: Bug report -about: Create a report to help us improve +name: "\U0001F41E Bug report" +about: Report an issue with ESLint or rules bundled with ESLint +title: '' +labels: bug, triage +assignees: '' --- -**Describe the bug** -A clear and concise description of what the bug is. + -**Screenshots** -If applicable, add screenshots to help explain your problem. +**Tell us about your environment** -**Desktop (please complete the following information):** + -- OS: [e.g. iOS] -- Browser [e.g. chrome, safari] -- Version [e.g. 22] +- **ESLint Version:** +- **Node Version:** +- **npm Version:** -**Smartphone (please complete the following information):** +**What parser (default, Babel-ESLint, etc.) are you using?** -- Device: [e.g. iPhone6] -- OS: [e.g. iOS8.1] -- Browser [e.g. stock browser, safari] -- Version [e.g. 22] +**Please show your full configuration:** -**Additional context** -Add any other context about the problem here. +
+Configuration + + + +```js +``` + +
+ +**What did you do? Please include the actual source code causing the issue, as well as the command that you used to run ESLint.** + + + +```js +``` + + + +```bash + +``` + +**What did you expect to happen?** + +**What actually happened? Please include the actual, raw output from ESLint.** + +**Are you willing to submit a pull request to fix this bug?** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index a09db44fb..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ab151c898..6a57d0e6b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,41 @@ -***Short description of what this resolves:*** + -***Proposed changes:*** +#### Prerequisites checklist +- [ ] I have read the [contributing guidelines](https://github.com/eslint/eslint/blob/master/CONTRIBUTING.md). + +#### What is the purpose of this pull request? (put an "X" next to an item) + +[ ] Documentation update +[ ] Bug fix ([template](https://raw.githubusercontent.com/eslint/eslint/master/templates/bug-report.md)) +[ ] New rule ([template](https://raw.githubusercontent.com/eslint/eslint/master/templates/rule-proposal.md)) +[ ] Changes an existing rule ([template](https://raw.githubusercontent.com/eslint/eslint/master/templates/rule-change-proposal.md)) +[ ] Add autofixing to a rule +[ ] Add a CLI option +[ ] Add something to the core +[ ] Other, please explain: + + + + + + + +#### What changes did you make? (Give an overview) + + +#### Is there anything you'd like reviewers to focus on? From 6fd927b20f88a78268eda4df0c3588a77a268b6e Mon Sep 17 00:00:00 2001 From: Christopher Quadflieg Date: Tue, 14 Jul 2020 11:06:48 +0200 Subject: [PATCH 2/9] chore: edit pr template --- .github/PULL_REQUEST_TEMPLATE.md | 53 +++++++++++++++----------------- 1 file changed, 24 insertions(+), 29 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6a57d0e6b..524450c3a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,41 +1,36 @@ - + #### Prerequisites checklist -- [ ] I have read the [contributing guidelines](https://github.com/eslint/eslint/blob/master/CONTRIBUTING.md). - -#### What is the purpose of this pull request? (put an "X" next to an item) +- [ ] I have read the [contributing guidelines](https://github.com/htmlhint/HTMLHint/blob/master/CONTRIBUTING.md). -[ ] Documentation update -[ ] Bug fix ([template](https://raw.githubusercontent.com/eslint/eslint/master/templates/bug-report.md)) -[ ] New rule ([template](https://raw.githubusercontent.com/eslint/eslint/master/templates/rule-proposal.md)) -[ ] Changes an existing rule ([template](https://raw.githubusercontent.com/eslint/eslint/master/templates/rule-change-proposal.md)) -[ ] Add autofixing to a rule -[ ] Add a CLI option -[ ] Add something to the core -[ ] Other, please explain: +#### What is the purpose of this pull request? - + - + + + + + + - - Read the pull request guide (https://eslint.org/docs/developer-guide/contributing/pull-requests) - - Include tests for this change - - Update documentation for this change (if appropriate) ---> +#### This pull request is related to one or multiple issue? - + -#### What changes did you make? (Give an overview) +#### What changes did you make? #### Is there anything you'd like reviewers to focus on? + + +#### Please tick every checkbox you have done + +- [ ] Tested my changes +- [ ] Added/Changed tested in test directory +- [ ] Added/Changed documentation + - [ ] in code + - [ ] in website + - [ ] in json schema From 40ce7a8182d02719b72f379c68abc4cd26b9b813 Mon Sep 17 00:00:00 2001 From: Christopher Quadflieg Date: Tue, 14 Jul 2020 11:15:00 +0200 Subject: [PATCH 3/9] chore: edit bug template --- .github/ISSUE_TEMPLATE/bug_report.md | 41 ++++++++-------------------- 1 file changed, 12 insertions(+), 29 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index bd3bc4af9..ca9ea2242 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,64 +1,47 @@ --- name: "\U0001F41E Bug report" -about: Report an issue with ESLint or rules bundled with ESLint +about: Report an issue with HTMLHint or rules bundled with HTMLHint title: '' labels: bug, triage assignees: '' --- - - **Tell us about your environment** - - -- **ESLint Version:** +- **HTMLHint Version:** - **Node Version:** - **npm Version:** - -**What parser (default, Babel-ESLint, etc.) are you using?** +- **os Version:** **Please show your full configuration:**
Configuration - + + +```json -```js ```
-**What did you do? Please include the actual source code causing the issue, as well as the command that you used to run ESLint.** +**What did you do? Please include the actual source code causing the issue, as well as the command that you used to run HTMLHint.** -```js +```html + ``` - + -```bash +```shell ``` **What did you expect to happen?** -**What actually happened? Please include the actual, raw output from ESLint.** +**What actually happened? Please include the actual, raw output from HTMLHint.** **Are you willing to submit a pull request to fix this bug?** From 1dd921f68556d1a57d6a691bd14ba3d4bd08c2c2 Mon Sep 17 00:00:00 2001 From: Christopher Quadflieg Date: Tue, 14 Jul 2020 11:16:33 +0200 Subject: [PATCH 4/9] chore: edit change template --- .github/ISSUE_TEMPLATE/CHANGE.md | 18 ++---------------- 1 file changed, 2 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/CHANGE.md b/.github/ISSUE_TEMPLATE/CHANGE.md index 7305c3dc1..e06467c98 100644 --- a/.github/ISSUE_TEMPLATE/CHANGE.md +++ b/.github/ISSUE_TEMPLATE/CHANGE.md @@ -2,25 +2,11 @@ name: "\U0001F4DD Non-rule change request" about: Request a change that is not a bug fix, rule change, or new rule title: '' -labels: enhancement, triage, core +labels: enhancement, triage assignees: '' --- - - -**The version of ESLint you are using.** +**The version of HTMLHint you are using.** **The problem you want to solve.** From 44e0afbd03406cc1566342139d575cf339b540b1 Mon Sep 17 00:00:00 2001 From: Christopher Quadflieg Date: Tue, 14 Jul 2020 11:20:13 +0200 Subject: [PATCH 5/9] chore: edit new rule template --- .github/ISSUE_TEMPLATE/NEW_RULE.md | 25 +++---------------------- 1 file changed, 3 insertions(+), 22 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/NEW_RULE.md b/.github/ISSUE_TEMPLATE/NEW_RULE.md index a8fa4b676..ab43bf085 100644 --- a/.github/ISSUE_TEMPLATE/NEW_RULE.md +++ b/.github/ISSUE_TEMPLATE/NEW_RULE.md @@ -2,30 +2,12 @@ name: "\U0001F680 New rule proposal" about: Propose a new rule to be added to ESLint title: '' -labels: triage, rule, feature +labels: triage, feature request assignees: '' --- - - **Please describe what the rule should do:** -**What new ECMAScript feature does this rule relate to?** - - - **What category of rule is this? (place an "X" next to just one item)** [ ] Warns about a potential error (problem) @@ -36,9 +18,8 @@ assignees: '' -```js -``` +```html -**Why should this rule be included in ESLint (instead of a plugin)?** +``` **Are you willing to submit a pull request to implement this rule?** From a2357da321c2f907e63682f2e6ac2ce57e918fe5 Mon Sep 17 00:00:00 2001 From: Christopher Quadflieg Date: Tue, 14 Jul 2020 11:23:49 +0200 Subject: [PATCH 6/9] chore: edit question template --- .github/ISSUE_TEMPLATE/QUESTION.md | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/QUESTION.md b/.github/ISSUE_TEMPLATE/QUESTION.md index a620ae448..2ace8fe4c 100644 --- a/.github/ISSUE_TEMPLATE/QUESTION.md +++ b/.github/ISSUE_TEMPLATE/QUESTION.md @@ -1,23 +1,16 @@ --- name: '⛔ Question' -about: Please go to https://eslint.org/chat +about: Please go to https://discord.com/invite/nJ6J9CP title: '' -labels: '' +labels: discussion assignees: '' --- - **What rule do you want to change?** **Does this change cause the rule to produce more or fewer warnings?** @@ -30,7 +16,8 @@ assignees: '' -```js +```html + ``` **What does the rule currently do for this code?** From cfccefc30d19f5f851491924a6b321f466f69302 Mon Sep 17 00:00:00 2001 From: Christopher Quadflieg Date: Tue, 14 Jul 2020 11:27:42 +0200 Subject: [PATCH 8/9] chore: edit secuirty template --- .github/ISSUE_TEMPLATE/SECURITY.md | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/SECURITY.md b/.github/ISSUE_TEMPLATE/SECURITY.md index 319bb404a..8d50ae11b 100644 --- a/.github/ISSUE_TEMPLATE/SECURITY.md +++ b/.github/ISSUE_TEMPLATE/SECURITY.md @@ -1,22 +1,11 @@ --- name: '⛔ Security issue' -about: Please file security issues at https://hackerone.com/eslint +about: Report a security issue with HTMLHint title: '' -labels: '' +labels: security assignees: '' --- - +**Are you willing to submit a pull request to fix this bug?** From 7d514b2f2c799c34a2fdc7276e2a233ba1990b5f Mon Sep 17 00:00:00 2001 From: Shinigami Date: Thu, 16 Jul 2020 15:07:58 +0200 Subject: [PATCH 9/9] chore: it is htmlhint --- .github/ISSUE_TEMPLATE/NEW_RULE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/NEW_RULE.md b/.github/ISSUE_TEMPLATE/NEW_RULE.md index ab43bf085..099cd27c3 100644 --- a/.github/ISSUE_TEMPLATE/NEW_RULE.md +++ b/.github/ISSUE_TEMPLATE/NEW_RULE.md @@ -1,6 +1,6 @@ --- name: "\U0001F680 New rule proposal" -about: Propose a new rule to be added to ESLint +about: Propose a new rule to be added to HTMLHint title: '' labels: triage, feature request assignees: ''