From 0d127b2cce5d7a8e7f47ec2d39e892c4ea58b38e Mon Sep 17 00:00:00 2001 From: Marc Mueller <30130371+cdce8p@users.noreply.github.com> Date: Mon, 26 Jul 2021 15:45:22 +0200 Subject: [PATCH 1/6] Improve issue forms --- .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 49 ++++++++++------------ .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml | 2 +- .github/ISSUE_TEMPLATE/QUESTION.yml | 7 ++-- 3 files changed, 26 insertions(+), 32 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml index 5118cd5b8a..85d57dc577 100644 --- a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -19,78 +19,73 @@ 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`: - + placeholder: | ```python # Please disable message unrelated to the bug # pylint: disable=missing-docstring, = 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 - ``` - validations: - required: false + render: ini - 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 (, 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 - ... ``` diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml index 59257ba0d0..ea04db0959 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/QUESTION.yml b/.github/ISSUE_TEMPLATE/QUESTION.yml index b01f526039..adce7e227b 100644 --- a/.github/ISSUE_TEMPLATE/QUESTION.yml +++ b/.github/ISSUE_TEMPLATE/QUESTION.yml @@ -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. From ea62625a31ee715ed9ad6abcbfb14dd28a708655 Mon Sep 17 00:00:00 2001 From: Marc Mueller <30130371+cdce8p@users.noreply.github.com> Date: Mon, 26 Jul 2021 15:45:46 +0200 Subject: [PATCH 2/6] Allow black issues --- .github/ISSUE_TEMPLATE/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 4e8b5ce057..78ef07382a 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,4 @@ -blank_issues_enabled: true +blank_issues_enabled: false contact_links: - name: 💬 Discord url: https://discord.gg/Egy6P8AMB5 From 457e922eb41cf6795e0c4612f35471a19d047520 Mon Sep 17 00:00:00 2001 From: Marc Mueller <30130371+cdce8p@users.noreply.github.com> Date: Tue, 27 Jul 2021 13:26:20 +0200 Subject: [PATCH 3/6] Changes after review --- .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 12 ++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 2 +- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml index 85d57dc577..c89452eb11 100644 --- a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -36,6 +36,18 @@ body: Please provide the part of the configuration that is causing the bug if required (Leave this part blank if the configuration is not relevant) 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: true - type: textarea id: current-behavior attributes: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 78ef07382a..4e8b5ce057 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,4 @@ -blank_issues_enabled: false +blank_issues_enabled: true contact_links: - name: 💬 Discord url: https://discord.gg/Egy6P8AMB5 From 1ddafdc315fe66963d44a2524663d6e8a791da06 Mon Sep 17 00:00:00 2001 From: Marc Mueller <30130371+cdce8p@users.noreply.github.com> Date: Tue, 27 Jul 2021 13:34:30 +0200 Subject: [PATCH 4/6] Improve placeholders --- .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml index c89452eb11..edc7001b61 100644 --- a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -20,11 +20,9 @@ body: What is the bug about? Please provide the code that is causing the issue, and configurations used if required placeholder: | - ```python # Please disable message unrelated to the bug # pylint: disable=missing-docstring, = b + 1 - ``` render: python validations: required: true @@ -35,6 +33,18 @@ body: 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) + placeholder: | + # Leave this black 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 @@ -42,9 +52,7 @@ body: label: Command used description: What was the command used to invoke pylint? placeholder: | - ``` pylint a.py - ``` render: shell validations: required: true @@ -54,10 +62,8 @@ body: label: Pylint output description: What is the current pylint output? placeholder: | - ``` ************* Module a a.py:3:1: E0001: invalid syntax (, line 1) (syntax-error) - ``` render: shell validations: required: true @@ -77,11 +83,9 @@ body: 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 validations: required: true @@ -97,7 +101,5 @@ body: label: Additional dependencies description: If applicable ie, if we can't reproduce without it placeholder: | - ``` pandas==0.23.2 marshmallow==3.10.0 - ``` From c6a2c475c87adc41def830450e2b2fd483ded6e0 Mon Sep 17 00:00:00 2001 From: Marc Mueller <30130371+cdce8p@users.noreply.github.com> Date: Tue, 27 Jul 2021 13:43:13 +0200 Subject: [PATCH 5/6] Small change --- .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml index edc7001b61..c38f6256ca 100644 --- a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -79,7 +79,7 @@ body: id: python-interpreter attributes: label: Pylint version - description: | + description: >- Please copy and paste the result of `pylint --version` or specify the range of version affected. placeholder: | From 201c29f35eec3831a2c5150994fc1301cf322747 Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Tue, 27 Jul 2021 20:36:12 +0200 Subject: [PATCH 6/6] Update .github/ISSUE_TEMPLATE/BUG-REPORT.yml --- .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml index c38f6256ca..64bfbaa16c 100644 --- a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -34,7 +34,7 @@ body: Please provide the part of the configuration that is causing the bug if required (Leave this part blank if the configuration is not relevant) placeholder: | - # Leave this black if the configuration is not relevant! + # Leave this blank if the configuration is not relevant! [MASTER] load-plugins=