From cb8fe24a77e43955577d8aa5949fcb5905931a98 Mon Sep 17 00:00:00 2001 From: Pavlenex Date: Fri, 10 Jun 2022 13:35:31 +0200 Subject: [PATCH] Add new issue forms for filing Bug Reports (#3846) * remove old .md template, add new issue form * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Andrew Camilleri * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: d11n * change browser from drop down to textfield * fix github yaml validation * enable blank templates * emoji consistency Co-authored-by: Andrew Camilleri Co-authored-by: d11n --- .github/ISSUE_TEMPLATE/bug-report.md | 63 ------------------------- .github/ISSUE_TEMPLATE/bug_report.yml | 68 +++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 12 ++--- 3 files changed, 74 insertions(+), 69 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index d21b62b3f..000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -name: "\U0001F41B Bug report" -about: Report a bug or a technical issue - ---- - - - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce the bug** -Steps to reproduce the reported bug: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** - - - -**Screenshots** - - - - -**Your BTCPay Environment (please complete the following information):** -- BTCPay Server Version: -- Deployment Method: -- Browser: - -**Logs (if applicable)** - - - - -**Setup Parameters** - - - -**Additional context** - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..8d467f771 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,68 @@ +name: 🐛 Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! Please provide as much information as you can. It helps us better understand the problem and fix it faster. + - type: textarea + id: version + attributes: + label: What is your BTCPay version? + description: You can see the version in the footer's bottom right corner + placeholder: I'm running BTCPay v1.X.X.X + validations: + required: true + - type: textarea + id: deployment + attributes: + label: How did you deploy BTCPay Server? + description: Docker, manual, third-party host? Read more on deployment methods [here](https://docs.btcpayserver.org/Deployment/) + placeholder: I'm running BTCPay Server on a... + validations: + required: true + - type: textarea + id: what-happened + attributes: + label: What happened? + description: A clear and concise description of what the bug is. + placeholder: Tell us what you see! + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: How did you encounter this bug? + description: Step by step describe how did you encounter the bug? + placeholder: 1. I clicked X 2. Then I clicked Y 3. See error + validations: + required: true + - type: textarea + id: logoutput + 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. Logs can be found in Server Settings > Logs. Here's how you can [troubleshoot an issue](https://docs.btcpayserver.org/Troubleshooting/) + render: shell + - type: textarea + id: browser + attributes: + label: What browser do you use? + description: Provide your browser and it's version. If you replicated issues on multiple browsers, let us know which ones. + placeholder: For example Safari 15.00, Chrome 10.0, Tor, Edge, etc + validations: + required: false + - type: textarea + id: additonal + attributes: + label: Additional information + description: Feel free to provide additional information. Screenshots are always helpful. + - type: checkboxes + id: terms + attributes: + label: Are you sure this is a bug report? + description: By submitting this report, you agree that this is not a support or a feature request. For general questions please read our [documentation](https://docs.btcpayserver.org). You can ask questions in [discussions](https://github.com/btcpayserver/btcpayserver/discussions) and [on our community chat](https://chat.btcpayserver.org) + options: + - label: I confirm this is a bug report + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index b5d8c5c38..a9d940c87 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,11 +1,11 @@ -blank_issues_enabled: false -contact_links: - - name: 🚀 Discussions +blank_issues_enabled: true +contact_links: + - name: 🚀 Discussions url: https://github.com/btcpayserver/btcpayserver/discussions - about: Technical discussions, questions and feature requests + about: Technical discussions, questions and feature requests - name: 📝 Official Documentation url: https://docs.btcpayserver.org - about: Check our documentation for answers to common questions - - name: 💬 Community Support Chat + about: Check our documentation for answers to common questions + - name: 💬 Community Support Chat url: https://chat.btcpayserver.org/ about: Ask general questions and get community support in real-time