From 7ce04e911ac89c582ffb6a6063f03b5294639864 Mon Sep 17 00:00:00 2001 From: Tommy Nguyen <4123478+tido64@users.noreply.github.com> Date: Wed, 13 Oct 2021 09:43:21 +0200 Subject: [PATCH 1/2] chore: use GitHub's form schema for filing issues --- .github/ISSUE_TEMPLATE/01_bug_report.md | 41 --------------- .github/ISSUE_TEMPLATE/02_feature_request.md | 17 ------ .../ISSUE_TEMPLATE/03_question_discussion.md | 11 ---- .github/ISSUE_TEMPLATE/bug_report.yml | 52 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 34 ++++++++++++ 5 files changed, 86 insertions(+), 69 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/01_bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/02_feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/03_question_discussion.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/01_bug_report.md b/.github/ISSUE_TEMPLATE/01_bug_report.md deleted file mode 100644 index a29d358b..00000000 --- a/.github/ISSUE_TEMPLATE/01_bug_report.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -name: '🐛 Bug report' -about: Something not working as expected -label: 'Bug' ---- - -## Current behavior - - - -## Expected behavior - - - -## Repro steps - - - -## Environment - -- **Platforms tested**: - - [ ] Android - - [ ] iOS - - [ ] macOS - - [ ] Windows -- **AsyncStorage version**: -- **Expo version**: -- **Environment**: - -- **Logs/Errors that may be relevant**: diff --git a/.github/ISSUE_TEMPLATE/02_feature_request.md b/.github/ISSUE_TEMPLATE/02_feature_request.md deleted file mode 100644 index 345fd1bc..00000000 --- a/.github/ISSUE_TEMPLATE/02_feature_request.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: '🔧 Feature request' -about: New functionality for Async Storage -label: 'Enhancement' ---- - -## Motivation - - - -## Description - - - -## New feature implementation - - \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/03_question_discussion.md b/.github/ISSUE_TEMPLATE/03_question_discussion.md deleted file mode 100644 index d2c01e68..00000000 --- a/.github/ISSUE_TEMPLATE/03_question_discussion.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -name: '🗣 Have a question / start a discussion' -about: You want to ask or discuss something -label: 'Question/Discussion' ---- - -## You want to: - - -## Details: - \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..56bc7ec6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,52 @@ +name: "Bug report \U0001F41B" +description: File a bug report +labels: [bug] +body: + - type: markdown + attributes: + value: |- + Thanks for taking the time to fill out this bug report! + + If you're using Expo, please check their forums for a similar issue first: https://forums.expo.io/ + - type: textarea + id: what-happened + attributes: + label: What happened? + description: What did you expect to happen? Can you attach build logs? Can you attach screenshots? + placeholder: Tell us what you see! + validations: + required: true + - type: input + id: version + attributes: + label: Version + description: What version of `@react-native-async-storage/async-storage` are you using? + placeholder: "Example: 1.15.9" + validations: + required: true + - type: checkboxes + id: platforms + attributes: + label: What platforms are you seeing this issue on? + description: "Select all that apply:" + options: + - label: Android + - label: iOS + - label: macOS + - label: Windows + - type: textarea + id: system-info + attributes: + label: System Information + placeholder: Run `npx react-native info` and paste the output here. + render: true + validations: + required: true + - type: textarea + id: repro-steps + attributes: + label: Steps to Reproduce + description: Tell us how to reproduce this issue, or provide a minimal demo where your issue can be easily reproduced. + placeholder: Tell us how to reproduce this issue. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..d6711d7d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,34 @@ +name: "Feature request \U0001F4A1" +description: Suggest an idea for this project +labels: [enhancement] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request! + - type: textarea + id: proposal + attributes: + label: Proposal + description: Provide a clear and concise description of your motivation for this proposal (e.g. \"I'm always frustrated when…\"), and what you want to happen instead. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives + description: Provide a clear and concise description of any alternative solutions or features you've considered. + validations: + required: true + - type: textarea + id: implementation + attributes: + label: Implementation Details + description: Provide a clear and concise description of how you think this could be implemented. + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional Context + description: Add any other context or screenshots about the feature request here. From a133b493befd015ce874bd1a15df44d95e06b329 Mon Sep 17 00:00:00 2001 From: Tommy Nguyen <4123478+tido64@users.noreply.github.com> Date: Wed, 13 Oct 2021 13:33:36 +0200 Subject: [PATCH 2/2] add web, make sections optional --- .github/ISSUE_TEMPLATE/bug_report.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.yml | 4 ---- 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 56bc7ec6..f71501cb 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -34,6 +34,7 @@ body: - label: iOS - label: macOS - label: Windows + - label: web - type: textarea id: system-info attributes: diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index d6711d7d..f50f958b 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -18,15 +18,11 @@ body: attributes: label: Alternatives description: Provide a clear and concise description of any alternative solutions or features you've considered. - validations: - required: true - type: textarea id: implementation attributes: label: Implementation Details description: Provide a clear and concise description of how you think this could be implemented. - validations: - required: true - type: textarea id: additional attributes: