From 7f138c11306cdf4be360d018528c33a3e024dd6b Mon Sep 17 00:00:00 2001 From: Matteo Bertucci Date: Sat, 29 May 2021 15:56:46 +0200 Subject: [PATCH] Issue templates: use HTML comments (#2269) This commit makes use of HTML comments inside GitHub issue templates to make sure that even if they aren't removed by the issue author they won't be shown in the rendered output. The goal is to simply make the issues less noisy by removing template messages. --- .github/ISSUE_TEMPLATE/bug_report.md | 31 +++++++++++++++-------- .github/ISSUE_TEMPLATE/feature_request.md | 24 ++++++++++++------ .github/ISSUE_TEMPLATE/style_issue.md | 20 ++++++++++----- 3 files changed, 51 insertions(+), 24 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 069795f..9924408 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,22 +6,31 @@ labels: bug assignees: "" --- -**Describe the bug** A clear and concise description of what the bug is. +**Describe the bug** -**To Reproduce** Steps to reproduce the behavior: + +**To Reproduce** + + + +**Expected behavior** -**Expected behavior** A clear and concise description of what you expected to happen. + **Environment (please complete the following information):** -- Version: \[e.g. main\] -- OS and Python version: \[e.g. Linux/Python 3.7.4rc1\] +- Version: +- OS and Python version: -**Does this bug also happen on main?** To answer this, you have two options: +**Does this bug also happen on main?** + + + +**Additional context** -**Additional context** Add any other context about the problem here. + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 56c2f0d..7c8cd1c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -6,14 +6,22 @@ labels: enhancement assignees: "" --- -**Is your feature request related to a problem? Please describe.** A clear and concise -description of what the problem is. Ex. I'm always frustrated when \[...\] +**Is your feature request related to a problem? Please describe.** -**Describe the solution you'd like** A clear and concise description of what you want to -happen. + -**Describe alternatives you've considered** A clear and concise description of any -alternative solutions or features you've considered. +**Describe the solution you'd like** -**Additional context** Add any other context or screenshots about the feature request -here. + + +**Describe alternatives you've considered** + + + +**Additional context** + + diff --git a/.github/ISSUE_TEMPLATE/style_issue.md b/.github/ISSUE_TEMPLATE/style_issue.md index 6d1f246..2ffd102 100644 --- a/.github/ISSUE_TEMPLATE/style_issue.md +++ b/.github/ISSUE_TEMPLATE/style_issue.md @@ -6,11 +6,15 @@ labels: design assignees: "" --- -**Describe the style change** A clear and concise description of how the style can be -improved. +**Describe the style change** -**Examples in the current _Black_ style** Think of some short code snippets that show -how the current _Black_ style is not great: + + +**Examples in the current _Black_ style** + + ```python def f(): @@ -18,7 +22,9 @@ def f(): pass ``` -**Desired style** How do you think _Black_ should format the above snippets: +**Desired style** + + ```python def f( @@ -26,4 +32,6 @@ def f( pass ``` -**Additional context** Add any other context about the problem here. +**Additional context** + + -- 2.39.5