Skip to content

chore: create propose new rule form #433

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.

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 8 commits into from
Jul 23, 2021
Merged
Changes from all commits
Commits
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
88 changes: 88 additions & 0 deletions .github/ISSUE_TEMPLATE/propose_new_rule.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
name: Propose a new rule
description: Propose a new rule for the eslint-plugin-testing-library.
labels: [new rule]
body:
- type: input
id: name_for_new_rule
attributes:
label: Name for new rule
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).
placeholder: prefer-wait-for
validations:
required: true

- type: textarea
id: description_of_the_new_rule
attributes:
label: Description of the new rule
description: Please describe what the new rule should do.
placeholder: The rule should ...
validations:
required: true

- type: textarea
id: testing_library_feature
attributes:
label: Testing Library feature
description: What Testing Library feature does this rule relate to?
placeholder: Enforce promises from async queries to be handled
validations:
required: true

- type: textarea
id: testing_library_frameworks
attributes:
label: Testing Library framework(s)
description: What Testing Library framework(s) does this rule relate to?
placeholder: Angular, React and Vue
validations:
required: true

- type: dropdown
id: category_of_rule
attributes:
label: What category of rule is this?
options:
- 'Warns about a potential error'
- 'Suggests an alternate way of doing something'
- 'Other (specify in textbox below)'
validations:
required: true

- type: textarea
id: textbox_category_of_rule_when_selected_other
attributes:
label: 'Optional: other category of rule'
description: 'If you selected _other_ in the dropdown menu above, explain more here.'
placeholder: Explain the category of rule in more detail.
validations:
required: false

- type: textarea
id: code_examples
attributes:
label: Code examples
description: Provide two to three code examples that this rule will warn about.
placeholder: Code example 1, code example 2.
validations:
required: true

- type: textarea
id: anything_else
attributes:
label: Anything else?
description: If there's anything else we need to know, tell us about it here.
placeholder: By the way, you also need to know about...
validations:
required: false

- type: dropdown
id: want_to_submit_pr_to_make_new_rule
attributes:
label: Do you want to submit a pull request to make the new rule?
options:
- 'Yes'
- 'Yes, but need help'
- 'No'
validations:
required: true