eslint/.github/ISSUE_TEMPLATE/NEW_RULE.md

   1 ---
   2 name: "\U0001F680 New rule proposal"
   3 about: Propose a new rule to be added to ESLint
   4 title: ''
   5 labels: triage, rule, feature
   6 assignees: ''
   7
   8 ---
   9
  10 <!--
  11     ESLint adheres to the [JS Foundation Code of Conduct](https://js.foundation/community/code-of-conduct).
  12
  13     This template is for new rule proposals. If you are proposing a new rule, please continue on. If you are here for another reason, please see below:
  14
  15     1. To report a bug: https://eslint.org/docs/developer-guide/contributing/reporting-bugs
  16     2. To request a rule change: https://eslint.org/docs/developer-guide/contributing/rule-changes
  17     3. To request a change that is not a bug fix, rule change, or new rule: https://eslint.org/docs/developer-guide/contributing/changes
  18     4. If you have any questions, please stop by our chatroom: https://gitter.im/eslint/eslint
  19
  20     Note that leaving sections blank will make it difficult for us to troubleshoot and we may have to close the issue.
  21 -->
  22
  23 **Please describe what the rule should do:**
  24
  25 **What category of rule is this? (place an "X" next to just one item)**
  26
  27 [ ] Warns about a potential error (problem)
  28 [ ] Suggests an alternate way of doing something (suggestion)
  29 [ ] Enforces code style (layout)
  30 [ ] Other (please specify:)
  31
  32 **Provide 2-3 code examples that this rule will warn about:**
  33
  34 <!-- Put your code examples here -->
  35 ```js
  36
  37 ```
  38
  39 **Why should this rule be included in ESLint (instead of a plugin)?**
  40
  41
  42 **Are you willing to submit a pull request to implement this rule?**