summaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE/BUG-REPORT.yml
blob: 811ed6360e1f676e96ffed889be00ca8439d19f6 (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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
name: 🐛 Bug report
description: Report a bug in pylint
labels: ["Needs triage :inbox_tray:"]
body:
  - type: markdown
    attributes:
      value: |
        **Thank you for wanting to report a bug in pylint!**

        ⚠ Please make sure that this [issue wasn't already requested][issue search], or already implemented in the main branch.


        [issue search]: https://github.com/pylint-dev/pylint/issues?q=is%3Aissue+is%3Aopen+

  - type: textarea
    id: what-happened
    attributes:
      label: Bug description
      description:
        What is the bug about? Please provide the code that is causing the issue, and
        configurations used if required
      placeholder: |
        # Please disable message unrelated to the bug
        # pylint: disable=missing-docstring,
        <a> = b + 1
    validations:
      required: true
  - type: textarea
    id: configuration
    attributes:
      label: Configuration
      description:
        Please provide the part of the configuration that is causing the bug if required
        (Leave this part blank if the configuration is not relevant)
      placeholder: |
        # Leave this blank if the configuration is not relevant!

        [MAIN]
        load-plugins=
            pylint.extensions.code_style

        [MESSAGE CONTROL]
        enable=
            useless-suppression

        # ...
      render: ini
  - type: textarea
    id: cmd-used
    attributes:
      label: Command used
      description: What was the command used to invoke pylint?
      placeholder: |
        pylint a.py
      render: shell
    validations:
      required: true
  - type: textarea
    id: current-behavior
    attributes:
      label: Pylint output
      description: What is the current pylint output?
      placeholder: |
        ************* Module a
        a.py:3:1: E0001: invalid syntax (<unknown>, line 1) (syntax-error)
      render: shell
    validations:
      required: true
  - type: textarea
    id: future-behavior
    attributes:
      label: Expected behavior
      description:
        What would you expect instead? For example expected output or behavior
    validations:
      required: true
  - type: textarea
    id: python-interpreter
    attributes:
      label: Pylint version
      description: >-
        Please copy and paste the result of `pylint --version` or specify the range of
        version affected.
      placeholder: |
        pylint 2.9.6
        astroid 2.6.5
        Python 3.8.10 (default, Jun  2 2021, 10:49:15) [GCC 9.4.0]
      render: shell
    validations:
      required: true
  - type: textarea
    attributes:
      label: OS / Environment
      description: >-
        Provide all relevant information below, e.g. OS version, terminal etc.
      placeholder: Fedora 33, Cygwin, etc.
  - type: textarea
    id: additional-deps
    attributes:
      label: Additional dependencies
      description: If applicable ie, if we can't reproduce without it
      placeholder: |
        Please copy and paste the result of `pip freeze`. For example:
        pandas==0.23.2
        marshmallow==3.10.0