From aeaedd2e5e3919cbdfb86aa19da9a611f71d0e40 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kat=20March=C3=A1n?= Date: Thu, 22 Jul 2021 10:39:20 -0700 Subject: [PATCH] Convert templates to github forms (#3818) * Create feature_request.yaml * Rename feature_request.yaml to feature_request.yml * Update feature_request.yml * Update feature_request.yml * Create bug_report.yml * Update bug_report.yml * Update bug_report.yml * Update feature_request.yml * Delete bug_report.md * Delete feature_request.md --- .github/ISSUE_TEMPLATE/bug_report.md | 47 ---------------- .github/ISSUE_TEMPLATE/bug_report.yml | 65 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ------- .github/ISSUE_TEMPLATE/feature_request.yml | 34 +++++++++++ 4 files changed, 99 insertions(+), 67 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 377622295..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. -2. -3. - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Configuration (please complete the following information):** - -Run `version | pivot` and paste the output to show OS, features, etc. - -``` -> version | pivot -╭───┬────────────────────┬───────────────────────────────────────────────────────────────────────╮ -│ # │ Column0 │ Column1 │ -├───┼────────────────────┼───────────────────────────────────────────────────────────────────────┤ -│ 0 │ version │ 0.24.1 │ -│ 1 │ build_os │ macos-x86_64 │ -│ 2 │ rust_version │ rustc 1.48.0 │ -│ 3 │ cargo_version │ cargo 1.48.0 │ -│ 4 │ pkg_version │ 0.24.1 │ -│ 5 │ build_time │ 2020-12-18 09:54:09 │ -│ 6 │ build_rust_channel │ release │ -│ 7 │ features │ ctrlc, default, directories, dirs, git, ichwh, rich-benchmark, │ -│ │ │ rustyline, term, uuid, which, zip │ -╰───┴────────────────────┴───────────────────────────────────────────────────────────────────────╯ -``` - - -**Add any other context about the problem here.** diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..2c6cebf36 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,65 @@ +name: Bug Report +description: Create a report to help us improve +body: + - type: textarea + id: description + attributes: + label: Describe the Bug + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: repro + attributes: + label: To Reproduce + description: Steps to reproduce the behavior + placeholder: | + 1. + 2. + 3. + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + placeholder: I expected nu to... + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: Please add any relevant screenshots here, if any + validations: + required: false + - type: textarea + id: config + attributes: + label: Configuration + description: "Please run `> version | pivot` and paste the output to show OS, features, etc" + placeholder: | + > version | pivot + ╭───┬────────────────────┬───────────────────────────────────────────────────────────────────────╮ + │ # │ Column0 │ Column1 │ + ├───┼────────────────────┼───────────────────────────────────────────────────────────────────────┤ + │ 0 │ version │ 0.24.1 │ + │ 1 │ build_os │ macos-x86_64 │ + │ 2 │ rust_version │ rustc 1.48.0 │ + │ 3 │ cargo_version │ cargo 1.48.0 │ + │ 4 │ pkg_version │ 0.24.1 │ + │ 5 │ build_time │ 2020-12-18 09:54:09 │ + │ 6 │ build_rust_channel │ release │ + │ 7 │ features │ ctrlc, default, directories, dirs, git, ichwh, rich-benchmark, │ + │ │ │ rustyline, term, uuid, which, zip │ + ╰───┴────────────────────┴───────────────────────────────────────────────────────────────────────╯ + validations: + required: false + - type: textarea + id: context + attributes: + label: Additional Context + description: Add any other context about the problem here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7d6..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -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 [...] - -**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. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..41003f67d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,34 @@ +name: Feature Request +description: "When you want a new feature for something that doesn't already exist" +body: + - type: textarea + id: problem + attributes: + label: Related Problem + description: Is your feature request related to a problem? Please describe. + placeholder: | + A clear and concise description of what the problem is. + Example: I am trying to do [...] but [...] + validations: + required: false + - type: textarea + id: desired + attributes: + label: "Describe the solution you'd like" + description: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: "Describe alternatives you've considered" + description: "A clear and concise description of any alternative solutions or features you've considered." + validations: + required: false + - type: textarea + id: context + attributes: + label: Additional Context and Details + description: Add any other context or screenshots about the feature request here. + validations: + required: false