From 59e48799bbfedeaebad05b0fdadeb79338ad1c8a Mon Sep 17 00:00:00 2001 From: KobeW50 <84587632+KobeW50@users.noreply.github.com> Date: Fri, 1 Mar 2024 08:02:39 -0500 Subject: [PATCH] Add GitHub issue templates (#123) --- .github/ISSUE_TEMPLATE/bug-report.yml | 68 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 ++++ .github/ISSUE_TEMPLATE/feature-request.yml | 35 +++++++++++ .github/ISSUE_TEMPLATE/question.yml | 28 +++++++++ 4 files changed, 142 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..2c9c2530 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,68 @@ +name: 🐞 Bug report +description: Report a bug or issue. +title: 'bug: ' +labels: ['Bug'] +body: + - type: markdown + attributes: + value: | + Before creating a bug report, please keep the following in mind: + + - Do not submit a duplicate bug report. You can review existing bug reports [here](https://github.com/twofas/2fas-android/labels/Bug). + - Security vulnerabilities should be reported to security@2fas.com. + - type: dropdown + attributes: + label: Bug type + options: + - Error at runtime + - Cosmetic + - Other + validations: + required: true + - type: textarea + attributes: + label: App version + description: Write down the app version in which the issue occurs. + placeholder: e.g. 5.3.5 + validations: + required: true + - type: textarea + attributes: + label: Device environment + description: Write down the Android version and model of your device. + placeholder: e.g. Android 14. Samsung S24 + validations: + required: true + - type: textarea + attributes: + label: Bug description + description: | + - Describe your bug in detail + - Add steps to reproduce the bug if possible (Step 1. ... Step 2. ...) + - Add images or videos if necessary (Enable screen capturing by going to Settings > Security > Allow screenshots, On) + - Add error logs in backticks if necessary + validations: + required: true + - type: textarea + attributes: + label: Solution + description: If applicable, add a possible solution to the bug. + - type: textarea + attributes: + label: Additional context + description: Add additional context here if necessary. + - type: checkboxes + id: acknowledgements + attributes: + label: Acknowledgements + description: Your bug report will be closed if you don't follow the checklist below. + options: + - label: This issue is not a duplicate of an existing bug report. + required: true + - label: I understand that security vulnerabilities should be reported to security@2fas.com instead of on GitHub. + required: true + - label: I have chosen an appropriate title. + required: true + - label: All requested information has been provided properly. + required: true + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..d8ab635b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: Help center + url: https://2fas.com/help-center/ + about: Check out our extensive FaQ and video guides! + - name: Discord + url: https://discord.gg/q4cP6qh2g5 + about: Need support or have a question? Our Discord members are there to help! + - name: Reddit + url: https://www.reddit.com/r/2fas_com/ + about: Get support and discuss 2FAS with our Reddit community! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..977576b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,35 @@ +name: ⭐ Feature request +description: Request a feature or enhancement. +title: 'feat: ' +labels: ['Feature'] +body: + - type: markdown + attributes: + value: | + Before creating a feature request, please ensure that it is not a duplicate of an existing feature request. You can review existing feature requests [here](https://github.com/twofas/2fas-android/labels/Feature). + - type: textarea + attributes: + label: Feature description + description: | + - Describe the feature in detail + - Add images, videos, links, examples, etc. if necessary + validations: + required: true + - type: textarea + attributes: + label: Motivation + description: Why should this feature be implemented? + validations: + required: true + - type: checkboxes + id: acknowledgements + attributes: + label: Acknowledgements + description: Your feature request will be closed if you don't follow the checklist below. + options: + - label: This issue is not a duplicate of an existing feature request. + required: true + - label: I have chosen an appropriate title. + required: true + - label: All requested information has been provided properly. + required: true diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 00000000..a88fee29 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,28 @@ +name: ❓ Question +description: Ask a question to the developers. +labels: ['Question'] +body: + - type: markdown + attributes: + value: | + Before asking a question, please ensure that it has not already been asked. You can review existing questions [here](https://github.com/twofas/2fas-android/labels/Question). + - type: textarea + attributes: + label: Question + description: | + - Explain your question clearly and in detail + - Add images and videos if necessary + validations: + required: true + - type: checkboxes + id: acknowledgements + attributes: + label: Acknowledgements + description: Your question will be closed if you don't follow the checklist below. + options: + - label: This issue is not a duplicate of an existing question. + required: true + - label: I have chosen an appropriate title. + required: true + - label: All requested information has been provided properly. + required: true