From 5cb7a58411465e8d5be70dd177a19d5a00158f3c Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Wed, 21 Jul 2021 20:18:44 +0200 Subject: [PATCH 1/7] Add links in .github/ISSUE_TEMPLATE/config.yml --- .github/ISSUE_TEMPLATE/config.yml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..d8177e368b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: true +contact_links: + - name: User manual + url: http://pylint.pycqa.org/en/latest/ + about: Documentation for users + - name: Technical references + url: http://pylint.pycqa.org/en/latest/technical_reference/index.html + about: Documentation for developper + - name: Contributing + url: http://pylint.pycqa.org/en/latest/development_guide/contribute.html + about: Documentation for contributor + - name: Discord server + url: https://discord.gg/Egy6P8AMB5 + about: Astroid and pylint informal dev discussion From 32ddc06fd5a591aa825b0584c0a78163cda0b1b8 Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Wed, 21 Jul 2021 20:34:17 +0200 Subject: [PATCH 2/7] Start using github's form in issue template Closes #4735 --- .github/ISSUE_TEMPLATE/1_Bug_report.md | 63 --------------- .github/ISSUE_TEMPLATE/2_Feature_request.md | 23 ------ .github/ISSUE_TEMPLATE/3_Question.md | 8 -- .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 88 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml | 29 +++++++ .github/ISSUE_TEMPLATE/QUESTION.yml | 19 +++++ .github/ISSUE_TEMPLATE/issue_template.md | 0 7 files changed, 136 insertions(+), 94 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/1_Bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/2_Feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/3_Question.md create mode 100644 .github/ISSUE_TEMPLATE/BUG-REPORT.yml create mode 100644 .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml create mode 100644 .github/ISSUE_TEMPLATE/QUESTION.yml create mode 100644 .github/ISSUE_TEMPLATE/issue_template.md diff --git a/.github/ISSUE_TEMPLATE/1_Bug_report.md b/.github/ISSUE_TEMPLATE/1_Bug_report.md deleted file mode 100644 index 88a20e0c07..0000000000 --- a/.github/ISSUE_TEMPLATE/1_Bug_report.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -name: Bug report -about: Report a bug in pylint ---- - - - -### Steps to reproduce - - - -### Current behavior - - - -### Expected behavior - -### pylint --version output - -Result of `pylint --version` output: - -``` - -``` - - diff --git a/.github/ISSUE_TEMPLATE/2_Feature_request.md b/.github/ISSUE_TEMPLATE/2_Feature_request.md deleted file mode 100644 index 0676e4636d..0000000000 --- a/.github/ISSUE_TEMPLATE/2_Feature_request.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project ---- - - - -### Is your feature request related to a problem? Please describe - -A clear and concise description of what the problem is. - -### Describe the solution you'd like - -A clear and concise description of what you want to happen. - -### Additional context - -Add any other context about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/3_Question.md b/.github/ISSUE_TEMPLATE/3_Question.md deleted file mode 100644 index 7e9187d85b..0000000000 --- a/.github/ISSUE_TEMPLATE/3_Question.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -name: Support question -about: - Questions about pylint that are not covered in the documentation - (https://pylint.pycqa.org/en/latest/) ---- - -## Question diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml new file mode 100644 index 0000000000..27e1781a7f --- /dev/null +++ b/.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 ? + description: + Please provide the code you linted, and configurations files and multiple named + file if required + value: | + Given a file `a.py`: + + ```python + # Please disable message unrelated to the bug + # pylint: disable=missing-docstring, + = b + 1 + ``` + + Using the following configuration pylintrc: + ```ini + # Please remove configuration unrelated to the bug + + [MESSAGES CONTROL] + enable=use-symbolic-message-instead, + ``` + validations: + required: true + - type: textarea + id: current-behavior + attributes: + label: What is the command used and its actual output ? + description: Please provide the command used and the current output + value: | + Result of `pylint a.py`: + ``` + ************* Module a + a.py:3:1: E0001: invalid syntax (, 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 + - 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 + ... + ``` diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml new file mode 100644 index 0000000000..1de20cc61f --- /dev/null +++ b/.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 + 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 diff --git a/.github/ISSUE_TEMPLATE/QUESTION.yml b/.github/ISSUE_TEMPLATE/QUESTION.yml new file mode 100644 index 0000000000..aaec276d56 --- /dev/null +++ b/.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 diff --git a/.github/ISSUE_TEMPLATE/issue_template.md b/.github/ISSUE_TEMPLATE/issue_template.md new file mode 100644 index 0000000000..e69de29bb2 From a6f9a046b55e739a04c9cfb0fc061687cb197ee4 Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Sun, 25 Jul 2021 14:04:30 +0200 Subject: [PATCH 3/7] More condensed pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b272731b2b..5cb6329f62 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,22 +1,14 @@ - -## 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/`. - [ ] Write a good description on what the PR does. - -## Description +--> ## Type of Changes @@ -29,11 +21,11 @@ https://github.com/PyCQA/pylint/blob/main/doc/development_guide/contribute.rst#r | ✓ | :hammer: Refactoring | | ✓ | :scroll: Docs | -## Related Issue +## Description Closes #XXX ---> From 3fadf66021c4c3eccb3c0282e6302ffb192b2feb Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Sun, 25 Jul 2021 14:21:58 +0200 Subject: [PATCH 4/7] Cleanup of .github/ISSUE_TEMPLATE/config.yml it's supposed to be contact links --- .github/ISSUE_TEMPLATE/config.yml | 9 --------- .github/ISSUE_TEMPLATE/issue_template.md | 0 ChangeLog | 1 + 3 files changed, 1 insertion(+), 9 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/issue_template.md diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index d8177e368b..5daf17e307 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,14 +1,5 @@ blank_issues_enabled: true contact_links: - - name: User manual - url: http://pylint.pycqa.org/en/latest/ - about: Documentation for users - - name: Technical references - url: http://pylint.pycqa.org/en/latest/technical_reference/index.html - about: Documentation for developper - - name: Contributing - url: http://pylint.pycqa.org/en/latest/development_guide/contribute.html - about: Documentation for contributor - name: Discord server url: https://discord.gg/Egy6P8AMB5 about: Astroid and pylint informal dev discussion diff --git a/.github/ISSUE_TEMPLATE/issue_template.md b/.github/ISSUE_TEMPLATE/issue_template.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/ChangeLog b/ChangeLog index 540f6f372a..778e863939 100644 --- a/ChangeLog +++ b/ChangeLog @@ -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 From 0641da385a051faf040549226a2bcb4303db54e8 Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Sun, 25 Jul 2021 18:18:40 +0200 Subject: [PATCH 5/7] Add more emojies take setuptools example --- .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 34 ++++++++++------------ .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml | 31 ++++++++++++++------ .github/ISSUE_TEMPLATE/QUESTION.yml | 26 ++++++++++++++++- .github/ISSUE_TEMPLATE/config.yml | 2 +- 4 files changed, 64 insertions(+), 29 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml index 27e1781a7f..e6d8c40a1e 100644 --- a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -1,18 +1,21 @@ -name: Bug report +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, or already implemented in the main branch. - type: textarea id: what-happened attributes: - label: What is the bug about ? + label: Bug description description: - Please provide the code you linted, and configurations files and multiple named - file if required + 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`: @@ -34,8 +37,8 @@ body: - type: textarea id: current-behavior attributes: - label: What is the command used and its actual output ? - description: Please provide the command used and the current output + label: Command used + description: What is the command used and its actual output ? value: | Result of `pylint a.py`: ``` @@ -47,9 +50,9 @@ body: - type: textarea id: future-behavior attributes: - label: What would you expect instead ? + label: Expected behavior description: - Tell us what you expect instead, for example expected output or behavior + What would you expect instead ? For example expected output or behavior validations: required: false - type: textarea @@ -63,17 +66,12 @@ body: Python 3.8.10 (default, Jun 2 2021, 10:49:15) [GCC 9.4.0] render: shell - - type: dropdown - id: os + - type: textarea attributes: - label: Operating system ? - options: - - Linux - - Mac - - PC - - Other - validations: - required: true + 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: diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml index 1de20cc61f..00a73e4241 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml @@ -1,29 +1,42 @@ -name: Feature request -description: Suggest an idea for this project +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 or already implemented in the main branch. - type: textarea id: current-problem attributes: - label: Please describe the problem this feature would solve - description: A clear and concise description of what the problem is. + 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: Please describe the desired solution + 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 - id: context attributes: label: Additional context - description: Add any other context about the feature request here. - validations: - required: false + 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. diff --git a/.github/ISSUE_TEMPLATE/QUESTION.yml b/.github/ISSUE_TEMPLATE/QUESTION.yml index aaec276d56..a46ec0a8b0 100644 --- a/.github/ISSUE_TEMPLATE/QUESTION.yml +++ b/.github/ISSUE_TEMPLATE/QUESTION.yml @@ -1,7 +1,31 @@ -name: Support question +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][Discussions]. + + + Thank you for your collaboration! + + + [issue search]: https://github.com/PyCQA/pylint/issues?q=is%3Aissue+is%3Aopen+ + + [Discussions]: https://discord.gg/Egy6P8AMB5 - type: textarea id: question attributes: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 5daf17e307..4e8b5ce057 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: true contact_links: - - name: Discord server + - name: 💬 Discord url: https://discord.gg/Egy6P8AMB5 about: Astroid and pylint informal dev discussion From 203c2ced5f00c02880d8acd127bcef9f2488dabe Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Sun, 25 Jul 2021 18:41:08 +0200 Subject: [PATCH 6/7] Make the configuration optional in the bug report template --- .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 34 ++++++++++++++++----------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml index e6d8c40a1e..cd985b2b61 100644 --- a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -7,8 +7,7 @@ body: value: | **Thank you for wanting to report a bug in pylint!** - ⚠ - Please make sure that this issue wasn't already requested, or already implemented in the main branch. + ⚠ Please make sure that this issue wasn't already requested, or already implemented in the main branch. - type: textarea id: what-happened attributes: @@ -24,16 +23,21 @@ body: # pylint: disable=missing-docstring, = b + 1 ``` - - Using the following configuration pylintrc: + 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 - # Please remove configuration unrelated to the bug - - [MESSAGES CONTROL] - enable=use-symbolic-message-instead, ``` validations: - required: true + required: false - type: textarea id: current-behavior attributes: @@ -50,7 +54,7 @@ body: - type: textarea id: future-behavior attributes: - label: Expected behavior + label: (Expected behavior) description: What would you expect instead ? For example expected output or behavior validations: @@ -58,8 +62,10 @@ body: - type: textarea id: python-interpreter attributes: - label: "Output of 'pylint --version'" - description: Please copy and paste the result + 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 @@ -68,14 +74,14 @@ body: render: shell - 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: From 5f6485d4298dfed17d744018074155481fdcc118 Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Sun, 25 Jul 2021 18:52:36 +0200 Subject: [PATCH 7/7] Add optional additional context in question/support --- .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 6 +++++- .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml | 9 ++++++--- .github/ISSUE_TEMPLATE/QUESTION.yml | 18 ++++++++++++------ 3 files changed, 23 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml index cd985b2b61..5118cd5b8a 100644 --- a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -7,7 +7,11 @@ body: value: | **Thank you for wanting to report a bug in pylint!** - ⚠ Please make sure that this issue wasn't already requested, or already implemented in the main branch. + ⚠ 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: diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml index 00a73e4241..59257ba0d0 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml @@ -7,8 +7,11 @@ body: value: | **Thank you for wanting to make a suggestion for pylint!** - ⚠ - Please make sure that this feature wasn't already requested or already implemented in the main branch. + ⚠ 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: @@ -31,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 a46ec0a8b0..b01f526039 100644 --- a/.github/ISSUE_TEMPLATE/QUESTION.yml +++ b/.github/ISSUE_TEMPLATE/QUESTION.yml @@ -15,17 +15,14 @@ body: ⚠ Verify first that your issue is not [already reported on GitHub][issue search]. - - If you are seeking community support, please consider [starting a - discussion][Discussions]. - - - Thank you for your collaboration! + 💬 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: @@ -41,3 +38,12 @@ body: 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.