From f17b28e427250cf2e52aa5ae947ba5521d398102 Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Sun, 25 Jul 2021 19:53:19 +0200 Subject: [PATCH] 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 --- .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 | 96 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml | 45 ++++++++++ .github/ISSUE_TEMPLATE/QUESTION.yml | 49 +++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/PULL_REQUEST_TEMPLATE.md | 16 +--- ChangeLog | 1 + 9 files changed, 200 insertions(+), 106 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/config.yml 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..5118cd5b8a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -0,0 +1,96 @@ +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][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: + label: Bug description + 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 + # Please disable message unrelated to the bug + # pylint: disable=missing-docstring, + = b + 1 + ``` + 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 + ``` + validations: + required: false + - 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`: + ``` + ************* Module a + a.py:3:1: E0001: invalid syntax (, line 1) (syntax-error) + ``` + validations: + required: true + - type: textarea + id: future-behavior + attributes: + label: (Expected behavior) + description: + What would you expect instead ? For example expected output or behavior + validations: + required: false + - 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 + 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: textarea + attributes: + 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) + 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..59257ba0d0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml @@ -0,0 +1,45 @@ +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][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: + 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: 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 + attributes: + 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. + + **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 new file mode 100644 index 0000000000..b01f526039 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/QUESTION.yml @@ -0,0 +1,49 @@ +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 + 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: + 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 + - 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. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..4e8b5ce057 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: 💬 Discord + url: https://discord.gg/Egy6P8AMB5 + about: Astroid and pylint informal dev discussion 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 ---> 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