summaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE/bug-report.yml
blob: 5f551a4be742e528c8da461ecbaff9ace72a503e (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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
---
name: 🐛 Bug report
description: >-
  Create a report to help us improve when
  something is not working correctly
title: '[BUG] '
labels:
- bug
- Needs Triage
issue_body: false  # default: true, adds a classic WSYWIG textarea, if on

body:
- type: markdown
  attributes:
    value: >
      **Thank you for wanting to report a bug in setuptools!**


      ⚠
      Verify first that your issue is not
      [already reported on GitHub][issue search] and keep in mind and
      keep in mind that we may have to keep the current behavior because
      [every change breaks someone's workflow][XKCD 1172].
      We try to be mindful about this.

      Also test if the latest release and main branch are affected too.


      If you are seeking community support, please consider
      [starting a discussion][Discussions].


      Thank you for your collaboration!


      [Discussions]: https://github.com/pypa/setuptools/discussions

      [issue search]: https://github.com/pypa/setuptools/search?q=is%3Aissue&type=issues

      [XKCD 1172]: https://xkcd.com/1172/

- type: markdown
  attributes:
    value: >-
      **Environment**
- type: input
  attributes:
    label: setuptools version
    placeholder: For example, setuptools===60.4.2
  validations:
    required: true
- type: input
  attributes:
    label: Python version
    placeholder: For example, Python 3.10
  validations:
    required: true
- type: input
  attributes:
    label: OS
    placeholder: For example, Gentoo Linux, RHEL 8, Arch Linux, macOS etc.
  validations:
    required: true
- type: textarea
  attributes:
    label: Additional environment information
    description: >-
      Feel free to add more information about your environment here.
    placeholder: >-
      This is only happening when I run setuptools on my fridge's patched firmware 🤯

- type: textarea
  attributes:
    label: Description
    description: >-
      A clear and concise description of what the bug is.
    placeholder: >-
      I tried doing X and I expected it to result in Y because the docs
      mentioned Z but what happened next what totally unexpected!
      And here's why...
  validations:
    required: true

- type: textarea
  attributes:
    label: Expected behavior
    description: >-
      A clear and concise description of what you expected to happen.
    placeholder: >-
      I tried doing X and I expected it to result in Y. I'm confused...
  validations:
    required: true

- type: textarea
  attributes:
    label: How to Reproduce
    description: >-
      Describe the steps to reproduce this bug.
    placeholder: |
      1. Integrate setuptools via '...'
      2. Then run '...'
      3. An error occurs.
  validations:
    required: true

- type: textarea
  attributes:
    label: Output
    description: >-
      Paste the output of the steps above, including the commands
      themselves and setuptools' output/traceback etc.
    value: |
      ```console

      ```
  validations:
    required: true


- type: checkboxes
  attributes:
    label: Code of Conduct
    description: |
      Read the [PSF Code of Conduct][CoC] first.

      [CoC]: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md
    options:
    - label: I agree to follow the PSF Code of Conduct
      required: true
...