Skip to content

Commit

Permalink
Improve Issue forms (#4749)
Browse files Browse the repository at this point in the history
* Improve issue forms
* Improve placeholders

Co-authored-by: Pierre Sassoulas <[email protected]>
  • Loading branch information
cdce8p and Pierre-Sassoulas authored Jul 27, 2021
1 parent e04de25 commit c04f92e
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 37 deletions.
73 changes: 41 additions & 32 deletions .github/ISSUE_TEMPLATE/BUG-REPORT.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,78 +19,87 @@ body:
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
placeholder: |
# Please disable message unrelated to the bug
# pylint: disable=missing-docstring,
<a> = b + 1
```
render: python
validations:
required: true
- type: textarea
id: configuration
attributes:
label: (Configuration)
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
```
placeholder: |
# Leave this blank if the configuration is not relevant!
[MASTER]
load-plugins=
pylint.extensions.code_style
[MESSAGE CONTROL]
enable=
useless-supression
# ...
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: false
required: true
- 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`:
```
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)
label: Expected behavior
description:
What would you expect instead ? For example expected output or behavior
What would you expect instead? For example expected output or behavior
validations:
required: false
required: true
- 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
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]
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)
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)
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
...
```
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ body:
required: true
- type: textarea
attributes:
label: (Additional context)
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.
Expand Down
7 changes: 3 additions & 4 deletions .github/ISSUE_TEMPLATE/QUESTION.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,15 @@ body:
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 ?
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)
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.

0 comments on commit c04f92e

Please sign in to comment.