Skip to content

Commit f17b28e

Browse files
Pierre-SassoulasPierre-Sassoulas
authored
Add Github issue forms and densify some templates (#4742)
* Add links in .github/ISSUE_TEMPLATE/config.yml * Start using github's form in issue template Closes #4735 * More condensed pull request template * Cleanup of .github/ISSUE_TEMPLATE/config.yml it's supposed to be contact links * Add more emojies take setuptools example * Make the configuration optional in the bug report template * Add optional additional context in question/support
1 parent a054796 commit f17b28e

File tree

9 files changed

+200
-106
lines changed

9 files changed

+200
-106
lines changed

‎.github/ISSUE_TEMPLATE/1_Bug_report.md‎

Lines changed: 0 additions & 63 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/2_Feature_request.md‎

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/3_Question.md‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/BUG-REPORT.yml‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
name: 🐛 Bug report
2+
description: Report a bug in pylint
3+
labels: [bug, needs triage]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
**Thank you for wanting to report a bug in pylint!**
9+
10+
⚠ Please make sure that this [issue wasn't already requested][issue search], or already implemented in the main branch.
11+
12+
13+
[issue search]: https://github.com/PyCQA/pylint/issues?q=is%3Aissue+is%3Aopen+
14+
15+
- type: textarea
16+
id: what-happened
17+
attributes:
18+
label: Bug description
19+
description:
20+
What is the bug about? Please provide the code that is causing the issue, and
21+
configurations used if required
22+
value: |
23+
Given a file `a.py`:
24+
25+
```python
26+
# Please disable message unrelated to the bug
27+
# pylint: disable=missing-docstring,
28+
<a> = b + 1
29+
```
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: configuration
34+
attributes:
35+
label: (Configuration)
36+
description:
37+
Please provide the part of the configuration that is causing the bug if required
38+
(Leave this part blank if the configuration is not relevant)
39+
value: |
40+
Using the following configuration:
41+
```ini
42+
```
43+
validations:
44+
required: false
45+
- type: textarea
46+
id: current-behavior
47+
attributes:
48+
label: Command used
49+
description: What is the command used and its actual output ?
50+
value: |
51+
Result of `pylint a.py`:
52+
```
53+
************* Module a
54+
a.py:3:1: E0001: invalid syntax (<unknown>, line 1) (syntax-error)
55+
```
56+
validations:
57+
required: true
58+
- type: textarea
59+
id: future-behavior
60+
attributes:
61+
label: (Expected behavior)
62+
description:
63+
What would you expect instead ? For example expected output or behavior
64+
validations:
65+
required: false
66+
- type: textarea
67+
id: python-interpreter
68+
attributes:
69+
label: (Version affected)
70+
description:
71+
Please copy and paste the result of 'pylint --version' or specify the range of
72+
version affected
73+
placeholder: |
74+
pylint 2.9.6
75+
astroid 2.6.5
76+
Python 3.8.10 (default, Jun 2 2021, 10:49:15)
77+
[GCC 9.4.0]
78+
render: shell
79+
- type: textarea
80+
attributes:
81+
label: (OS / Environment)
82+
description: >-
83+
Provide all relevant information below, e.g. OS version, terminal etc.
84+
placeholder: Fedora 33, Cygwin, etc.
85+
- type: textarea
86+
id: additional-deps
87+
attributes:
88+
label: (Additional dependencies)
89+
description: If applicable ie, if we can't reproduce without it
90+
placeholder: |
91+
Additional dependencies:
92+
```
93+
pandas==0.23.2
94+
marshmallow==3.10.0
95+
...
96+
```

‎.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: ✨ Feature request
2+
description: Suggest an idea for pylint
3+
labels: [enhancement, needs triage]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
**Thank you for wanting to make a suggestion for pylint!**
9+
10+
⚠ Please make sure that [this feature wasn't already requested][issue search] or already implemented in the main branch.
11+
12+
13+
[issue search]: https://github.com/PyCQA/pylint/issues?q=is%3Aissue+is%3Aopen+
14+
15+
- type: textarea
16+
id: current-problem
17+
attributes:
18+
label: Current problem
19+
description:
20+
What are you trying to do, that you are unable to achieve with pylint as it
21+
currently stands?
22+
placeholder: >-
23+
I'm trying to do X and I'm missing feature Y for this to be easily achievable.
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: proposed-solution
28+
attributes:
29+
label: Desired solution
30+
description: A clear and concise description of what you want to happen.
31+
placeholder: >-
32+
When I do X, I want to achieve Y in a situation when Z.
33+
validations:
34+
required: true
35+
- type: textarea
36+
attributes:
37+
label: (Additional context)
38+
description: >
39+
Add any other context, links, etc. about the feature here. Describe how the
40+
feature would be used, why it is needed and what it would solve.
41+
42+
**HINT:** You can paste https://gist.github.com links for larger files.
43+
placeholder: >-
44+
I asked on https://stackoverflow.com/... and the community advised me to do X, Y
45+
and Z.

‎.github/ISSUE_TEMPLATE/QUESTION.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: 🤔 Support question
2+
description: Questions about pylint that are not covered in the documentation
3+
labels: [question, needs triage, documentation]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: >
8+
**Thank you for wanting to report a problem with pylint documentation!**
9+
10+
11+
Please fill out your suggestions below. If the problem seems straightforward,
12+
feel free to go ahead and submit a pull request instead!
13+
14+
15+
⚠ Verify first that your issue is not [already reported on GitHub][issue
16+
search].
17+
18+
💬 If you are seeking community support, please consider [starting a discussion
19+
on Discord][Discussions].
20+
21+
22+
[issue search]: https://github.com/PyCQA/pylint/issues?q=is%3Aissue+is%3Aopen+
23+
24+
[Discussions]: https://discord.gg/Egy6P8AMB5
25+
26+
- type: textarea
27+
id: question
28+
attributes:
29+
label: Question
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: documentation
34+
attributes:
35+
label: Documentation for future user
36+
description:
37+
Where did you expect this information to be ? What do we need to add or what do
38+
we need to reorganize ?
39+
validations:
40+
required: true
41+
- type: textarea
42+
attributes:
43+
label: (Additional context)
44+
description: >
45+
Add any other context, links, etc. about the question here.
46+
47+
placeholder: >-
48+
I asked on https://stackoverflow.com/... and the community advised me to do X, Y
49+
and Z.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 💬 Discord
4+
url: https://discord.gg/Egy6P8AMB5
5+
about: Astroid and pylint informal dev discussion

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,14 @@
11
<!--
2-
32
Thank you for submitting a PR to pylint!
43
54
To ease the process of reviewing your PR, do make sure to complete the following boxes.
65
7-
You can also read more about contributing to pylint in this document:
8-
https://github.com/PyCQA/pylint/blob/main/doc/development_guide/contribute.rst#repository
9-
-->
10-
11-
## Steps
12-
136
- [ ] Add yourself to CONTRIBUTORS if you are a new contributor.
147
- [ ] Add a ChangeLog entry describing what your PR does.
15-
- [ ] If it's a new feature or an important bug fix, add a What's New entry in
8+
- [ ] If it's a new feature, or an important bug fix, add a What's New entry in
169
`doc/whatsnew/<current release.rst>`.
1710
- [ ] Write a good description on what the PR does.
18-
19-
## Description
11+
-->
2012

2113
## Type of Changes
2214

@@ -29,11 +21,11 @@ https://github.com/PyCQA/pylint/blob/main/doc/development_guide/contribute.rst#r
2921
| ✓ | :hammer: Refactoring |
3022
| ✓ | :scroll: Docs |
3123

32-
## Related Issue
24+
## Description
3325

3426
<!--
3527
If this PR fixes a particular issue, use the following to automatically close that issue
3628
once this PR gets merged:
29+
-->
3730

3831
Closes #XXX
39-
-->

‎ChangeLog‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Release date: TBA
1818
Put bug fixes that should not wait for a new minor version here
1919

2020

21+
2122
What's New in Pylint 2.9.5?
2223
===========================
2324
Release date: 2021-07-21

0 commit comments

Comments
 (0)