You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thank you for suggesting a new rule! Before submitting, please ensure your request meets our rule writing standards.
13
+
14
+
## References on Rule Design
15
+
- [What makes a good rule](https://package.elm-lang.org/packages/jfmengels/elm-review/latest/Review-Rule#what-makes-a-good-rule)
16
+
- [When to write or enable a rule](https://package.elm-lang.org/packages/jfmengels/elm-review/latest/#when-to-write-or-enable-a-rule)
17
+
18
+
- type: textarea
19
+
id: problem
20
+
attributes:
21
+
label: Problem Description
22
+
description: Please describe what problem this rule will solve. Provide specific code examples to illustrate the issue.
23
+
placeholder: "This rule will solve..."
24
+
validations:
25
+
required: true
26
+
27
+
- type: textarea
28
+
id: alternative-solutions
29
+
attributes:
30
+
label: Alternative Solutions
31
+
description: Have you tried to solve the problem by changing the API or introducing a new API? Why aren't these methods sufficient to solve the problem?
32
+
placeholder: "I've tried..."
33
+
validations:
34
+
required: true
35
+
36
+
- type: textarea
37
+
id: rule-name-and-message
38
+
attributes:
39
+
label: Rule Name and Error Message
40
+
description: Suggest a name for the rule, as well as the error message and details that should be displayed when the rule is violated.
41
+
placeholder: |
42
+
Rule name: [PluginName]/[YourRuleName]
43
+
44
+
Error message: Briefly and clearly describe the problem
45
+
46
+
Details: Provide more background information and suggested solutions
47
+
validations:
48
+
required: true
49
+
50
+
- type: textarea
51
+
id: examples
52
+
attributes:
53
+
label: Examples
54
+
description: Provide code examples that should be flagged and code examples that should not be flagged.
55
+
placeholder: |
56
+
Code that should be flagged:
57
+
```tsx
58
+
// Problematic code
59
+
```
60
+
61
+
Code that should not be flagged:
62
+
```tsx
63
+
// Correct code
64
+
```
65
+
validations:
66
+
required: true
67
+
68
+
- type: checkboxes
69
+
id: checklist
70
+
attributes:
71
+
label: Evaluation Checklist
72
+
description: Please check the following items to ensure the rule suggestion is reasonable
73
+
options:
74
+
- label: I have had problems with the pattern I want to forbid
75
+
required: true
76
+
- label: I could not find a way to solve the problem by changing the API of the problematic code or introducing a new API
77
+
required: true
78
+
- label: I have thought very hard about what the corner cases could be and what kind of patterns this would forbid that are actually okay, and they are acceptable
79
+
required: true
80
+
- label: I think the rule explains well enough how to solve the issue, to make sure beginners are not blocked by it
81
+
required: true
82
+
- label: I have discussed this rule with team members, and they all find it valuable
0 commit comments