From 0df2d5ff5b534da6933a133c697b44a3a1e26047 Mon Sep 17 00:00:00 2001 From: brandonlenz Date: Thu, 25 May 2023 10:11:12 -0400 Subject: [PATCH 1/3] For fields where formatting is important, place examples in description so they can be easily copy/pasted, but do not prefill --- .github/ISSUE_TEMPLATE/bug.yml | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index c01761f1c..51ec2d81f 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -24,25 +24,30 @@ body: id: steps-to-reproduce attributes: label: Steps to Reproduce - description: "How can the issue be reliably reproduced? feel free to include screenshots or other supporting artifacts" - placeholder: | + description: | + How can the issue be reliably reproduced? Feel free to include screenshots or other supporting artifacts + Example: 1. In the test environment, fill out the application for a new domain 2. Click the button to trigger a save/submit on the final page and complete the application 3. See the error + value: | + 1. validations: required: true - type: textarea id: environment attributes: - label: Environment - description: "Where is this issue occurring? If related to development environment, list the specific relevant tool versions" - placeholder: | + label: Environment (optional) + description: | + Where is this issue occurring? If related to development environment, list the relevant tool versions. + Example: + - Environment: Sandbox - Browser: Chrome x.y.z - Python: x.y.z - type: textarea id: additional-context attributes: - label: Additional Context + label: Additional Context (optional) description: "Please include additional references, screenshots, documentation, etc. that are relevant" From 0632ff1fe7aa8ad918b51aef43b72aab51baa5eb Mon Sep 17 00:00:00 2001 From: brandonlenz Date: Thu, 25 May 2023 10:40:54 -0400 Subject: [PATCH 2/3] Add a help section --- .github/ISSUE_TEMPLATE/bug.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 51ec2d81f..3a9227e81 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -4,6 +4,10 @@ title: "[Bug]: " labels: ["bug"] body: + - type: markdown + id: help + attributes: + value: GitHub Issues use [GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) for formatting. - type: textarea id: current-behavior attributes: From 86d1ca9609bd0258b074d609e1be1d9ce3c07f1a Mon Sep 17 00:00:00 2001 From: brandonlenz Date: Thu, 25 May 2023 10:44:24 -0400 Subject: [PATCH 3/3] Make help section a "note" --- .github/ISSUE_TEMPLATE/bug.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 3a9227e81..e3e6a6f23 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -7,7 +7,9 @@ body: - type: markdown id: help attributes: - value: GitHub Issues use [GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) for formatting. + value: | + > **Note** + > GitHub Issues use [GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) for formatting. - type: textarea id: current-behavior attributes: