From 1178868bb8b7d0db406588c3a86ea0ce5cbd2649 Mon Sep 17 00:00:00 2001 From: Boris Zbarsky Date: Wed, 14 Dec 2022 15:27:03 -0500 Subject: [PATCH] Allow markdown in issue template descriptions. (#24085) Instead of forcing preformatting on the text people type as their reproduction steps, allow them to type markdown and nudge toward using proper formatting and attaching logs as files via the placeholder. --- .github/ISSUE_TEMPLATE/1-bug-report.yaml | 14 ++++++++------ .../ISSUE_TEMPLATE/100-documentation-issue.yaml | 1 - .github/ISSUE_TEMPLATE/2-1.0-issue.yaml | 14 ++++++++------ .github/ISSUE_TEMPLATE/3-sve-1.0-issue.yaml | 14 ++++++++------ .github/ISSUE_TEMPLATE/50-tooling-fix.yaml | 14 ++++++++------ .github/ISSUE_TEMPLATE/60-platform-fix.yaml | 14 ++++++++------ .github/ISSUE_TEMPLATE/70-trivial-fix.yaml | 6 ------ .github/ISSUE_TEMPLATE/80-feature-request.yaml | 1 - .../ISSUE_TEMPLATE/99-github-workflow-issue.yaml | 1 - 9 files changed, 40 insertions(+), 39 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yaml b/.github/ISSUE_TEMPLATE/1-bug-report.yaml index 3266f2bb9ba5e4..3e30ed6dd3088c 100644 --- a/.github/ISSUE_TEMPLATE/1-bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/1-bug-report.yaml @@ -11,12 +11,14 @@ body: attributes: label: Reproduction steps description: "How do you trigger this bug? Please walk us through it step by step." - value: | - 1. - 2. - 3. - ... - render: bash + placeholder: | + Please list reproduction steps step by step. + Place shell commands between ```. + Attach logs as files instead of pasting them in. + 1. + 2. + 3. + ... validations: required: true - type: input diff --git a/.github/ISSUE_TEMPLATE/100-documentation-issue.yaml b/.github/ISSUE_TEMPLATE/100-documentation-issue.yaml index 5bc63949be7039..69e23c81bd887e 100644 --- a/.github/ISSUE_TEMPLATE/100-documentation-issue.yaml +++ b/.github/ISSUE_TEMPLATE/100-documentation-issue.yaml @@ -16,7 +16,6 @@ body: 2. 3. ... - render: bash validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/2-1.0-issue.yaml b/.github/ISSUE_TEMPLATE/2-1.0-issue.yaml index 15c8a8a64e2937..93fbf8bec7e533 100644 --- a/.github/ISSUE_TEMPLATE/2-1.0-issue.yaml +++ b/.github/ISSUE_TEMPLATE/2-1.0-issue.yaml @@ -11,12 +11,14 @@ body: attributes: label: Reproduction steps description: "How do you trigger this bug? Please walk us through it step by step." - value: | - 1. - 2. - 3. - ... - render: bash + placeholder: | + Please list reproduction steps step by step. + Place shell commands between ```. + Attach logs as files instead of pasting them in. + 1. + 2. + 3. + ... validations: required: true - type: input diff --git a/.github/ISSUE_TEMPLATE/3-sve-1.0-issue.yaml b/.github/ISSUE_TEMPLATE/3-sve-1.0-issue.yaml index 90de36176c2e3f..340e9ff38aeea6 100644 --- a/.github/ISSUE_TEMPLATE/3-sve-1.0-issue.yaml +++ b/.github/ISSUE_TEMPLATE/3-sve-1.0-issue.yaml @@ -11,12 +11,14 @@ body: attributes: label: Reproduction steps description: "How do you trigger this bug? Please walk us through it step by step." - value: | - 1. - 2. - 3. - ... - render: bash + placeholder: | + Please list reproduction steps step by step. + Place shell commands between ```. + Attach logs as files instead of pasting them in. + 1. + 2. + 3. + ... validations: required: true - type: input diff --git a/.github/ISSUE_TEMPLATE/50-tooling-fix.yaml b/.github/ISSUE_TEMPLATE/50-tooling-fix.yaml index ed314f9cb925a0..74888c105040a9 100644 --- a/.github/ISSUE_TEMPLATE/50-tooling-fix.yaml +++ b/.github/ISSUE_TEMPLATE/50-tooling-fix.yaml @@ -11,12 +11,14 @@ body: attributes: label: Reproduction steps / Feature description: "How do you trigger this issue and/or can you please explain this new feature? Please walk us through it step by step." - value: | - 1. - 2. - 3. - ... - render: bash + placeholder: | + Please list reproduction steps step by step. + Place shell commands between ```. + Attach logs as files instead of pasting them in. + 1. + 2. + 3. + ... validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/60-platform-fix.yaml b/.github/ISSUE_TEMPLATE/60-platform-fix.yaml index 9593847a228290..b6878edede4826 100644 --- a/.github/ISSUE_TEMPLATE/60-platform-fix.yaml +++ b/.github/ISSUE_TEMPLATE/60-platform-fix.yaml @@ -11,12 +11,14 @@ body: attributes: label: Reproduction steps description: "How do you trigger this issue? Please walk us through it step by step." - value: | - 1. - 2. - 3. - ... - render: bash + placeholder: | + Please list reproduction steps step by step. + Place shell commands between ```. + Attach logs as files instead of pasting them in. + 1. + 2. + 3. + ... validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/70-trivial-fix.yaml b/.github/ISSUE_TEMPLATE/70-trivial-fix.yaml index d9438ab611f83b..dd7108d7c60326 100644 --- a/.github/ISSUE_TEMPLATE/70-trivial-fix.yaml +++ b/.github/ISSUE_TEMPLATE/70-trivial-fix.yaml @@ -23,12 +23,6 @@ body: attributes: label: Explanation description: "(Optional) If other, why do you think this is trivial?" - value: | - 1. - 2. - 3. - ... - render: bash validations: required: false - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/80-feature-request.yaml b/.github/ISSUE_TEMPLATE/80-feature-request.yaml index 1526dc23c54755..e62a5a02415c6b 100644 --- a/.github/ISSUE_TEMPLATE/80-feature-request.yaml +++ b/.github/ISSUE_TEMPLATE/80-feature-request.yaml @@ -13,7 +13,6 @@ body: description: "What feature are you looking to add? Please walk us through it!" value: | ... - render: bash validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/99-github-workflow-issue.yaml b/.github/ISSUE_TEMPLATE/99-github-workflow-issue.yaml index 2f1570e4b860a0..831a6e6ab14c05 100644 --- a/.github/ISSUE_TEMPLATE/99-github-workflow-issue.yaml +++ b/.github/ISSUE_TEMPLATE/99-github-workflow-issue.yaml @@ -16,7 +16,6 @@ body: 2. 3. ... - render: bash validations: required: true - type: dropdown