summaryrefslogtreecommitdiffstats
path: root/src/tools/clippy/.github/ISSUE_TEMPLATE/new_lint.yml
blob: 0b43d8d70c007ab46645b2fe1085ef84953a6d6b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
name: New lint suggestion
description: Suggest a new Clippy lint.
labels: ["A-lint"]
body:
  - type: markdown
    attributes:
      value: Thank you for your lint idea!
  - type: textarea
    id: what
    attributes:
      label: What it does
      description: What does this lint do?
    validations:
      required: true
  - type: input
    id: lint-name
    attributes:
      label: Lint Name
      description: Please provide the lint name.
  - type: dropdown
    id: category
    attributes:
      label: Category
      description: >
        What category should this lint go into? If you're unsure you can select
        multiple categories. You can find a category description in the
        `README`.
      multiple: true
      options:
        - correctness
        - suspicious
        - style
        - complexity
        - perf
        - pedantic
        - restriction
        - cargo
  - type: textarea
    id: advantage
    attributes:
      label: Advantage
      description: >
        What is the advantage of the recommended code over the original code?
      placeholder: |
        - Remove bounds check inserted by ...
        - Remove the need to duplicate/store ...
        - Remove typo ...
  - type: textarea
    id: drawbacks
    attributes:
      label: Drawbacks
      description: What might be possible drawbacks of such a lint?
  - type: textarea
    id: example
    attributes:
      label: Example
      description: >
        Include a short example showing when the lint should trigger together
        with the improved code.
      value: |
        ```rust
        <code>
        ```

        Could be written as:

        ```rust
        <code>
        ```
    validations:
      required: true