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
Add Github issue forms and densify some templates #4742
Changes from all commits
5cb7a58
32ddc06
a6f9a04
3fadf66
0641da3
203c2ce
5f6485d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
This file was deleted.
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
name: π Bug report | ||
description: Report a bug in pylint | ||
labels: [bug, needs triage] | ||
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/PyCQA/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 | ||
value: | | ||
Given a file `a.py`: | ||
|
||
```python | ||
# 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) | ||
value: | | ||
Using the following configuration: | ||
```ini | ||
``` | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: current-behavior | ||
attributes: | ||
label: Command used | ||
description: What is the command used and its actual output ? | ||
value: | | ||
Result of `pylint a.py`: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This line is also not really necessary There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Very often the reporter do not gives the pylint output and just gives a general description "I don't like the output", I'll also keep this, that as it nudges reporter to make a report that permits to understand the problem without thinking too much or linting the code ourselves. |
||
``` | ||
************* Module a | ||
a.py:3:1: E0001: invalid syntax (<unknown>, line 1) (syntax-error) | ||
``` | ||
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: false | ||
- type: textarea | ||
id: python-interpreter | ||
attributes: | ||
label: (Version affected) | ||
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 | ||
- 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: | | ||
Additional dependencies: | ||
``` | ||
pandas==0.23.2 | ||
marshmallow==3.10.0 | ||
... | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
name: β¨ Feature request | ||
description: Suggest an idea for pylint | ||
labels: [enhancement, needs triage] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
**Thank you for wanting to make a suggestion for pylint!** | ||
|
||
β Please make sure that [this feature wasn't already requested][issue search] or already implemented in the main branch. | ||
|
||
|
||
[issue search]: https://github.com/PyCQA/pylint/issues?q=is%3Aissue+is%3Aopen+ | ||
|
||
- type: textarea | ||
id: current-problem | ||
attributes: | ||
label: Current problem | ||
description: | ||
What are you trying to do, that you are unable to achieve with pylint as it | ||
currently stands? | ||
placeholder: >- | ||
I'm trying to do X and I'm missing feature Y for this to be easily achievable. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: proposed-solution | ||
attributes: | ||
label: Desired solution | ||
description: A clear and concise description of what you want to happen. | ||
placeholder: >- | ||
When I do X, I want to achieve Y in a situation when Z. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: (Additional context) | ||
description: > | ||
Add any other context, links, etc. about the feature here. Describe how the | ||
feature would be used, why it is needed and what it would solve. | ||
|
||
**HINT:** You can paste https://gist.github.com links for larger files. | ||
placeholder: >- | ||
I asked on https://stackoverflow.com/... and the community advised me to do X, Y | ||
and Z. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
name: π€ Support question | ||
description: Questions about pylint that are not covered in the documentation | ||
labels: [question, needs triage, documentation] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: > | ||
**Thank you for wanting to report a problem with pylint documentation!** | ||
|
||
|
||
Please fill out your suggestions below. If the problem seems straightforward, | ||
feel free to go ahead and submit a pull request instead! | ||
|
||
|
||
β Verify first that your issue is not [already reported on GitHub][issue | ||
search]. | ||
|
||
π¬ If you are seeking community support, please consider [starting a discussion | ||
on Discord][Discussions]. | ||
|
||
|
||
[issue search]: https://github.com/PyCQA/pylint/issues?q=is%3Aissue+is%3Aopen+ | ||
|
||
[Discussions]: https://discord.gg/Egy6P8AMB5 | ||
|
||
- type: textarea | ||
id: question | ||
attributes: | ||
label: Question | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: documentation | ||
attributes: | ||
label: Documentation for future user | ||
description: | ||
Where did you expect this information to be ? What do we need to add or what do | ||
we need to reorganize ? | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: (Additional context) | ||
description: > | ||
Add any other context, links, etc. about the question here. | ||
|
||
placeholder: >- | ||
I asked on https://stackoverflow.com/... and the community advised me to do X, Y | ||
and Z. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: π¬ Discord | ||
url: https://discord.gg/Egy6P8AMB5 | ||
about: Astroid and pylint informal dev discussion |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These lines are not really necessary
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well I think it nudges the reporter to provide a reproducible example and I really like having a reproducible example, I think I'll keep that.