From 55a035c19c77ea1f17ffcfa4f7fc58d8e7f3d7bf Mon Sep 17 00:00:00 2001 From: problematicconsumer Date: Sat, 7 Oct 2023 11:59:05 +0330 Subject: [PATCH] Add issue template --- .github/ISSUE_TEMPLATE/bug_report.yaml | 103 +++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yaml | 5 ++ 2 files changed, 108 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000..65ee712c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,103 @@ +name: Bug Report +description: Report a bug encountered while using Hiddify Next +body: + - type: markdown + attributes: + value: | + If you have a feature idea or need help, please go to [our Telegram group](https://t.me/hiddify_board). + + Please make sure to provide a descriptive, deterministic, and reproducible report. It saves time for both the developers and users who are looking for solutions. Providing as much information as possible, including screenshots and logs, is highly appreciated. This will help us to better understand the issue and respond more effectively. + + Please DO NOT use this template to ask questions. There are other appropriate channels to ask questions. This template is strictly for reporting bugs. + - type: checkboxes + id: confirm-search + attributes: + label: Search first + description: Please search [existing issues](https://github.com/hiddify/hiddify-next/issuess) before reporting. + options: + - label: I searched and no similar issues were found + required: true + - type: textarea + id: problem + attributes: + label: What Happened? + description: | + Please provide as much info as possible. Not doing so may result in your bug not being addressed in a timely manner. + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Reproduce the Bug + description: | + Please tell us the steps to reproduce the bug. + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: | + Please tell us what's the behavior you expect. + validations: + required: false + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: | + If applicable, add screenshots or screen recordings to help explain your problem. + validations: + required: false + - type: input + id: version + attributes: + label: Version + description: What version of Hiddify Next are you using? + placeholder: v1.3.8 etc + validations: + required: true + - type: dropdown + id: platform + attributes: + label: Platform/OS + description: What platform are you seeing the problem on? + multiple: true + options: + - Android + - Windows + - macOS + - Linux + - iOS + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional Context + description: | + If applicable, add additional context to help explain your problem. + validations: + required: false + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + + - type: checkboxes + id: ask-pr + attributes: + label: Are you willing to submit a PR? If you know how to fix the bug. + description: | + If you are not familiar with programming, you can skip this step. + If you are a developer and know how to fix the bug, you can submit a PR to fix it. + Your contributions are greatly appreciated and play a vital role in helping to improve the project! + options: + - label: I'm willing to submit a PR (Thank you!) diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 00000000..51356b73 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Questions & Help + url: https://t.me/hiddify_board + about: Ask a question about Hiddify Next