Skip to content
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

Merged
merged 7 commits into from Jul 25, 2021
Merged
63 changes: 0 additions & 63 deletions .github/ISSUE_TEMPLATE/1_Bug_report.md

This file was deleted.

23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/2_Feature_request.md

This file was deleted.

8 changes: 0 additions & 8 deletions .github/ISSUE_TEMPLATE/3_Question.md

This file was deleted.

88 changes: 88 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG-REPORT.yml
@@ -0,0 +1,88 @@
name: Bug report
description: Report a bug in pylint
labels: [bug, needs triage]
body:
- type: markdown
attributes:
value: |
Please make sure that this issue wasn't already requested, or already implemented in the main branch.
- type: textarea
id: what-happened
attributes:
label: What is the bug about ?
Pierre-Sassoulas marked this conversation as resolved.
Show resolved Hide resolved
description:
Please provide the code you linted, and configurations files and multiple named
file if required
Pierre-Sassoulas marked this conversation as resolved.
Show resolved Hide resolved
value: |
Given a file `a.py`:

Comment on lines +23 to +24
Copy link
Member

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

Copy link
Member Author

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.

```python
# Please disable message unrelated to the bug
# pylint: disable=missing-docstring,
<a> = b + 1
```

Using the following configuration pylintrc:
```ini
# Please remove configuration unrelated to the bug

[MESSAGES CONTROL]
enable=use-symbolic-message-instead,
```
Pierre-Sassoulas marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: true
- type: textarea
id: current-behavior
attributes:
label: What is the command used and its actual output ?
Pierre-Sassoulas marked this conversation as resolved.
Show resolved Hide resolved
description: Please provide the command used and the current output
value: |
Result of `pylint a.py`:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line is also not really necessary

Copy link
Member Author

Choose a reason for hiding this comment

The 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: What would you expect instead ?
description:
Tell us what you expect instead, for example expected output or behavior
validations:
required: false
- type: textarea
id: python-interpreter
attributes:
label: "Output of 'pylint --version'"
description: Please copy and paste the result
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: dropdown
id: os
attributes:
label: Operating system ?
options:
- Linux
- Mac
- PC
- Other
validations:
required: true
Pierre-Sassoulas marked this conversation as resolved.
Show resolved Hide resolved
- 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
...
```
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
@@ -0,0 +1,29 @@
name: Feature request
description: Suggest an idea for this project
labels: [enhancement, needs triage]
body:
- type: markdown
attributes:
value: |
Please make sure that this feature wasn't already requested or already implemented in the main branch.
- type: textarea
id: current-problem
attributes:
label: Please describe the problem this feature would solve
Pierre-Sassoulas marked this conversation as resolved.
Show resolved Hide resolved
description: A clear and concise description of what the problem is.
validations:
required: true
- type: textarea
id: proposed-solution
attributes:
label: Please describe the desired solution
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional context
description: Add any other context about the feature request here.
validations:
required: false
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/QUESTION.yml
@@ -0,0 +1,19 @@
name: Support question
description: Questions about pylint that are not covered in the documentation
labels: [question, needs triage, documentation]
body:
- 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
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Discord server
url: https://discord.gg/Egy6P8AMB5
about: Astroid and pylint informal dev discussion
16 changes: 4 additions & 12 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -1,22 +1,14 @@
<!--

Thank you for submitting a PR to pylint!

To ease the process of reviewing your PR, do make sure to complete the following boxes.

You can also read more about contributing to pylint in this document:
https://github.com/PyCQA/pylint/blob/main/doc/development_guide/contribute.rst#repository
-->

## Steps

- [ ] Add yourself to CONTRIBUTORS if you are a new contributor.
- [ ] Add a ChangeLog entry describing what your PR does.
- [ ] If it's a new feature or an important bug fix, add a What's New entry in
- [ ] If it's a new feature, or an important bug fix, add a What's New entry in
`doc/whatsnew/<current release.rst>`.
- [ ] Write a good description on what the PR does.

## Description
-->

## Type of Changes

Expand All @@ -29,11 +21,11 @@ https://github.com/PyCQA/pylint/blob/main/doc/development_guide/contribute.rst#r
| βœ“ | :hammer: Refactoring |
| βœ“ | :scroll: Docs |

## Related Issue
## Description

<!--
If this PR fixes a particular issue, use the following to automatically close that issue
once this PR gets merged:
-->

Closes #XXX
-->
1 change: 1 addition & 0 deletions ChangeLog
Expand Up @@ -18,6 +18,7 @@ Release date: TBA
Put bug fixes that should not wait for a new minor version here



What's New in Pylint 2.9.5?
===========================
Release date: 2021-07-21
Expand Down