From 4e24f1ab1fe7dbf8d8b143895d9a4bfab1091e1e Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Sun, 25 Jul 2021 18:18:40 +0200 Subject: [PATCH] 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 | 20 ++++++++++++- .github/ISSUE_TEMPLATE/config.yml | 2 +- 4 files changed, 58 insertions(+), 29 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml index 27e1781a7f8..e6d8c40a1e7 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 1de20cc61f4..00a73e4241f 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 aaec276d56e..55c7f9f06d3 100644 --- a/.github/ISSUE_TEMPLATE/QUESTION.yml +++ b/.github/ISSUE_TEMPLATE/QUESTION.yml @@ -1,7 +1,25 @@ -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 5daf17e307e..4e8b5ce0579 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