From 6bd9c4deb76bcda6974eec8f2f53e8d0f08a8d22 Mon Sep 17 00:00:00 2001 From: StarHamster Date: Tue, 26 Apr 2022 01:41:47 +0700 Subject: [PATCH] Improve issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 31 --------- .github/ISSUE_TEMPLATE/bug_report.yml | 63 +++++++++++++++++++ .../ISSUE_TEMPLATE/dev-contributor-request.md | 30 --------- .../dev-contributor-request.yml | 56 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 34 ---------- .github/ISSUE_TEMPLATE/feature-request.yml | 40 ++++++++++++ .github/ISSUE_TEMPLATE/import-csv-request.md | 44 ------------- .github/ISSUE_TEMPLATE/import-csv-request.yml | 59 +++++++++++++++++ 8 files changed, 218 insertions(+), 139 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/dev-contributor-request.md create mode 100644 .github/ISSUE_TEMPLATE/dev-contributor-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/import-csv-request.md create mode 100644 .github/ISSUE_TEMPLATE/import-csv-request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 3d27cfd116..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[BUG] ..." -labels: bug -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Smartphone (please complete the following information):** - - Device: [e.g. Samsung Galaxy S20 Ultra] - - OS: [e.g. Android 11] - -**Additional context** -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 0000000000..38b4964c21 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,63 @@ +name: Bug Report +description: Create a report to help us improve +title: "[BUG] ..." +labels: ["bug"] +body: + - type: checkboxes + id: terms + attributes: + label: Please confirm the following + options: + - label: I checked [the current issues](https://github.com/ILIYANGERMANOV/ivy-wallet/issues) for duplicate problems + required: true + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + placeholder: I clicked something and my millions are not displayed anymore! + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: To Reproduce + description: "Steps to reproduce the behavior:" + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + value: "1. " + validations: + required: false + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + placeholder: My millions should be displayed! + validations: + required: false + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem. + validations: + required: false + - type: input + id: smartphone + attributes: + label: Smartphone + description: Specify the phone model and Android version. + placeholder: Samsung Galaxy S20 Ultra, Android 11 + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional context + description: Add any other context about the problem here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/dev-contributor-request.md b/.github/ISSUE_TEMPLATE/dev-contributor-request.md deleted file mode 100644 index 06e443b552..0000000000 --- a/.github/ISSUE_TEMPLATE/dev-contributor-request.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: Dev/Contributor Request -about: Report a problem or suggest an improvement -title: '' -labels: dev -assignees: '' - ---- - -**Is the project building?** -Yes/No - -**What would you like to improve?** -I want to: -- a -- b -- c -- d - -Because: - -- e -- f -- g - -**Other** -Share your thoughts in free format. - -**Logs** -Share any logs or information that might help us resolve your issue faster. diff --git a/.github/ISSUE_TEMPLATE/dev-contributor-request.yml b/.github/ISSUE_TEMPLATE/dev-contributor-request.yml new file mode 100644 index 0000000000..12d930151f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/dev-contributor-request.yml @@ -0,0 +1,56 @@ +name: Dev/Contributor Request +description: Report a problem or suggest an improvement +labels: ["dev"] +body: + - type: checkboxes + id: terms + attributes: + label: Please confirm the following + options: + - label: I checked [the current issues](https://github.com/ILIYANGERMANOV/ivy-wallet/issues) for duplicate problems + required: true + - type: dropdown + id: project-building + attributes: + label: Is the project building? + options: + - "Yes" + - "No" + validations: + required: false + - type: textarea + id: description + attributes: + label: What would you like to improve? + description: "I want to:" + placeholder: | + - a + - b + - c + value: "- " + validations: + required: true + - type: textarea + id: because + attributes: + label: Because... + placeholder: | + - d + - e + - f + validations: + required: false + - type: textarea + id: other + attributes: + label: Other + description: Share your thoughts in free format. + validations: + required: false + - type: textarea + id: logs + attributes: + label: Logs + description: Share any logs or information that might help us resolve your issue faster. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 4c93063285..0000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Feature Request -about: Request a feature to make Ivy Wallet better -title: '' -labels: user request -assignees: '' - ---- - -**What do you want to be added or improved?** -As a user I want to ... - -**Is your request already listed in [Issues](https://github.com/ILIYANGERMANOV/ivy-wallet/issues)?** -- [ ] Yes, it already exists. -- [ ] No, it's a new issue. -- [ ] I'm not sure but I've checked. - -_Put an `x` in the boxes that apply._ - -- [x] Demo: Checking checkbox using `[x]` - -**Explain with bullets why do you need it** -- a -- b -- c -- d - -**Explain how do you imagine it in detail** -Write any implementation details that might help us better fulfill your feature request. -**I'd like to:** -- a -- b -- c -- d diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000000..b583c2d01d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,40 @@ +name: Feature Request +description: Request a feature to make Ivy Wallet better +title: "[FEATURES] ..." +labels: ["user request"] +body: + - type: checkboxes + id: terms + attributes: + label: Please confirm the following + options: + - label: I checked [the current issues](https://github.com/ILIYANGERMANOV/ivy-wallet/issues) for duplicate problems + required: true + - type: textarea + id: description + attributes: + label: What do you want to be added or improved? + description: "I want to:" + placeholder: As a user I want to ... + value: As a user I want to + validations: + required: true + - type: textarea + id: reason + attributes: + label: Why do you need it? + description: Explain with bullets why do you need it. + placeholder: | + - a + - b + - c + value: "- " + validations: + required: false + - type: textarea + id: because + attributes: + label: How do you imagine it? + description: Write any implementation details that might help us better fulfill your feature request. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/import-csv-request.md b/.github/ISSUE_TEMPLATE/import-csv-request.md deleted file mode 100644 index cc83e24b90..0000000000 --- a/.github/ISSUE_TEMPLATE/import-csv-request.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -name: Import CSV Request -about: Request an import CSV from specific app to be supported. -title: 'Import CSV from {APP_NAME} ({PACKAGE_NAME})' -labels: user request -assignees: '' - ---- - -**Is your request already listed in [Issues](https://github.com/ILIYANGERMANOV/ivy-wallet/issues)?** - -- [ ] Yes -- [ ] No -- [ ] Kinda (please describe): - -### Google PlayStore URL to the app from which you want to import: -- URL: - -### Attach Samples CSV from the app: - -Attach an exported CSV file from the app to this issue. - -**CSV file requirements:** -- [ ] includes Income type transaction -- [ ] includes Expense type transaction -- [ ] includes Transfer type transaction (optional) -- [ ] includes title, description, all attributes available in the app (optional) - -**Is CSV export from the app free?** - -- [ ] Yes -- [ ] No -- [ ] It depends (please describe): - -_Put an `x` in the boxes that apply._ - -- [x] Demo: Checking checkbox using `[x]` - -## Developer/Contributor Notes - -- Checkout - this **[Sample Commit](https://github.com/ILIYANGERMANOV/ivy-wallet/commit/323ed68343a0904ee33f226480716a30368fd646)** - to see how import CSV works in Ivy Wallet -- Make sure that the imported dates of the transactions are correct \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/import-csv-request.yml b/.github/ISSUE_TEMPLATE/import-csv-request.yml new file mode 100644 index 0000000000..89b2fd6d6e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/import-csv-request.yml @@ -0,0 +1,59 @@ +name: Import CSV Request +description: Request an import CSV from specific app to be supported. +title: "[IMPORT] {APP_NAME} ({PACKAGE_NAME})" +labels: ["user request"] +body: + - type: checkboxes + id: terms + attributes: + label: Please confirm the following + options: + - label: I checked [the current issues](https://github.com/ILIYANGERMANOV/ivy-wallet/issues) for duplicate problems + required: true + - type: input + id: url-to-app + attributes: + label: Google PlayStore URL to the app from which you want to import + description: A clear and concise description of what the bug is. + placeholder: https://play.google.com/store/apps/details?id=com.cool.app + validations: + required: false + - type: textarea + id: csv-sample + attributes: + label: Attach Samples CSV from the app + description: Attach an exported CSV file from the app to this issue. + validations: + required: false + - type: dropdown + id: requirements + attributes: + label: CSV file requirements + multiple: true + options: + - includes Income type transaction + - includes Expense type transaction + - includes Transfer type transaction (optional) + - includes title, description, all attributes available in the app (optional) + validations: + required: false + - type: dropdown + id: cost + attributes: + label: Is CSV export from the app free? + options: + - "Yes" + - "No" + - It depends + validations: + required: false + - type: textarea + id: notes + attributes: + label: Developer/Contributor Notes + description: Just a few notes for developers. Ignore the content and don't change it, please. + value: | + - Checkout this **[Sample Commit](https://github.com/ILIYANGERMANOV/ivy-wallet/commit/323ed68343a0904ee33f226480716a30368fd646)** to see how import CSV works in Ivy Wallet + - Make sure that the imported dates of the transactions are correct" + validations: + required: true