From 40a684bd93e03f2fe6cbed7e502de2fcb3fadb40 Mon Sep 17 00:00:00 2001 From: Midori <50433979+natsuk4ze@users.noreply.github.com> Date: Wed, 16 Aug 2023 17:50:16 +0900 Subject: [PATCH] Update issue templates (#91) --- .github/ISSUE_TEMPLATE/bug.yml | 79 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 24 ------- .github/ISSUE_TEMPLATE/feature.yml | 39 +++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 11 ---- 4 files changed, 118 insertions(+), 35 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 00000000..6eea7e19 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,79 @@ +name: Report a bug +description: Create a report to help us improve +labels: "\U0001F41D bug, \U0001F440 in triage" +assignees: natsuk4ze +body: + - type: markdown + attributes: + value: | + Thank you for using gal! + If you are looking for support, please check out our documentation. + + - https://github.com/natsuk4ze/gal/wiki + - https://github.com/natsuk4ze/gal/discussions + - type: textarea + attributes: + label: Overview + description: Please clarify what kind of bug it is. + validations: + required: true + - type: textarea + attributes: + label: Steps to reproduce + description: Please tell us exactly how to reproduce the problem you are running into. + placeholder: | + 1. ... + 2. ... + 3. ... + validations: + required: true + - type: textarea + attributes: + label: Code sample + description: Please create a minimal reproducible sample + value: | +
Code sample + + ```dart + [Paste your code here] + ``` + +
+ validations: + required: true + - type: textarea + attributes: + label: Logs + description: Please show the error log. + value: | +
Logs + + ```console + [Paste your logs here] + ``` + +
+ validations: + required: true + + - type: textarea + attributes: + label: Environment + description: Please tell us your environment. + placeholder: | + - Device: [e.g. iPhone14 emulator] + - OS: [e.g. iOS16] + - gal Version: [e.g. 1.8.0] + validations: + required: true + - type: textarea + attributes: + label: File you want to save + description: Please upload the file if you can. + value: | +
+ Screenshots / Video demonstration + + [Upload media here] + +
\ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index df53f9a8..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "*replace this text*" -labels: "\U0001F41D bug, \U0001F440 in triage" -assignees: natsuk4ze - ---- - -**Describe the bug** - -**Log** - -**To Reproduce** - -**Media you want to save** -- File: [upload here if you can] -- File Name: [e.g. video.mp4] -- Codec (Video Only): [e.g. H.264] - -**Environment** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Gal Version: [e.g. 1.7.0] diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 00000000..8454dde0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,39 @@ +name: Feature requests +description: Suggest a new idea for gal. +labels: "✨ feature, \U0001F4A1 idia, \U0001F440 in triage" +assignees: natsuk4ze +body: + - type: markdown + attributes: + value: | + Thank you for using gal! + If you are looking for support, please check out our documentation. + + - https://github.com/natsuk4ze/gal/wiki + - https://github.com/natsuk4ze/gal/discussions + - type: textarea + attributes: + label: Proposal + description: | + Briefly but precisely describe what you would like gal to be able to do. + + Consider attaching something showing what you are imagining: + * images + * videos + * code samples + validations: + required: true + - type: textarea + attributes: + label: Use case + description: | + Please tell us the problem you are running into that led to you wanting + a new feature. + + Is your feature request related to a problem? Please give a clear and + concise description of what the problem is. + + Describe the alternative solutions you've considered. Is there a package + on pub.dev that already solves this? + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 02df0b0e..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "*replace this text*" -labels: "✨ feature, \U0001F4A1 idia, \U0001F440 in triage" -assignees: natsuk4ze - ---- - -**Problem this request is trying to solve** -*replace this text to details about the problem this request is trying to solve. Who needs it, use cases, when?*