|
| 1 | +name: Propose a new rule |
| 2 | +description: Propose a new rule for the eslint-plugin-testing-library. |
| 3 | +labels: [new rule] |
| 4 | +body: |
| 5 | + - type: input |
| 6 | + id: name_for_new_rule |
| 7 | + attributes: |
| 8 | + label: Name for new rule |
| 9 | + description: Suggest a name for the new rule that follows the [rule naming conventions](https://github.com/testing-library/eslint-plugin-testing-library/blob/main/CONTRIBUTING.md#rule-naming-conventions). |
| 10 | + placeholder: prefer-wait-for |
| 11 | + validations: |
| 12 | + required: true |
| 13 | + |
| 14 | + - type: textarea |
| 15 | + id: description_of_the_new_rule |
| 16 | + attributes: |
| 17 | + label: Description of the new rule |
| 18 | + description: Please describe what the new rule should do. |
| 19 | + placeholder: The rule should ... |
| 20 | + validations: |
| 21 | + required: true |
| 22 | + |
| 23 | + - type: textarea |
| 24 | + id: testing_library_feature |
| 25 | + attributes: |
| 26 | + label: Testing Library feature |
| 27 | + description: What Testing Library feature does this rule relate to? |
| 28 | + placeholder: Enforce promises from async queries to be handled |
| 29 | + validations: |
| 30 | + required: true |
| 31 | + |
| 32 | + - type: textarea |
| 33 | + id: testing_library_frameworks |
| 34 | + attributes: |
| 35 | + label: Testing Library framework(s) |
| 36 | + description: What Testing Library framework(s) does this rule relate to? |
| 37 | + placeholder: Angular, React and Vue |
| 38 | + validations: |
| 39 | + required: true |
| 40 | + |
| 41 | + - type: dropdown |
| 42 | + id: category_of_rule |
| 43 | + attributes: |
| 44 | + label: What category of rule is this? |
| 45 | + options: |
| 46 | + - 'Warns about a potential error' |
| 47 | + - 'Suggests an alternate way of doing something' |
| 48 | + - 'Other (specify in textbox below)' |
| 49 | + validations: |
| 50 | + required: true |
| 51 | + |
| 52 | + - type: textarea |
| 53 | + id: textbox_category_of_rule_when_selected_other |
| 54 | + attributes: |
| 55 | + label: 'Optional: other category of rule' |
| 56 | + description: 'If you selected _other_ in the dropdown menu above, explain more here.' |
| 57 | + placeholder: Explain the category of rule in more detail. |
| 58 | + validations: |
| 59 | + required: false |
| 60 | + |
| 61 | + - type: textarea |
| 62 | + id: code_examples |
| 63 | + attributes: |
| 64 | + label: Code examples |
| 65 | + description: Provide two to three code examples that this rule will warn about. |
| 66 | + placeholder: Code example 1, code example 2. |
| 67 | + validations: |
| 68 | + required: true |
| 69 | + |
| 70 | + - type: textarea |
| 71 | + id: anything_else |
| 72 | + attributes: |
| 73 | + label: Anything else? |
| 74 | + description: If there's anything else we need to know, tell us about it here. |
| 75 | + placeholder: By the way, you also need to know about... |
| 76 | + validations: |
| 77 | + required: false |
| 78 | + |
| 79 | + - type: dropdown |
| 80 | + id: want_to_submit_pr_to_make_new_rule |
| 81 | + attributes: |
| 82 | + label: Do you want to submit a pull request to make the new rule? |
| 83 | + options: |
| 84 | + - 'Yes' |
| 85 | + - 'Yes, but need help' |
| 86 | + - 'No' |
| 87 | + validations: |
| 88 | + required: true |
0 commit comments