From 9a9fca67d50a0d192d3cf784354aacd5938e12cb Mon Sep 17 00:00:00 2001 From: Juan Calderon-Perez <835733+gaby@users.noreply.github.com> Date: Sat, 23 Oct 2021 22:58:35 -0400 Subject: [PATCH 1/4] Migrate Bug Report to Github Issue Forms --- .github/ISSUE_TEMPLATE/bug_report.md | 42 ---------- .github/ISSUE_TEMPLATE/bug_report.yaml | 105 +++++++++++++++++++++++++ 2 files changed, 105 insertions(+), 42 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 069ed6cc..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: bug -assignees: '' - ---- - -**Is it a duplicated question?** -Please search in Issues without filters: https://github.com/louislam/uptime-kuma/issues?q= - -**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. - -**Info** -Uptime Kuma Version: -Using Docker?: Yes/No -Docker Version: -Node.js Version (Without Docker only): -OS: -Browser: - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Error Log** -It is easier for us to find out the problem. - -Docker: `docker logs ` -PM2: `~/.pm2/logs/` (e.g. `/home/ubuntu/.pm2/logs`) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000..acffc517 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,105 @@ +name: "🐛 Bug Report" +description: "Submit a bug report to help us improve" +title: "🐛 Bug Report: " +labels: [bug] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: steps-to-reproduce + validations: + required: true + attributes: + label: "👟 Reproduction steps" + description: "How do you trigger this bug? Please walk us through it step by step." + placeholder: "..." + - type: textarea + id: expected-behavior + validations: + required: true + attributes: + label: "👍 Expected behavior" + description: "What did you think would happen?" + placeholder: "..." + - type: textarea + id: actual-behavior + validations: + required: true + attributes: + label: "👎 Actual Behavior" + description: "What actually happen?" + placeholder: "..." + - type: dropdown + id: uptime-kuma-version + attributes: + label: "🐻 Uptime-Kuma version" + description: "What version of Uptime-Kuma are you running?" + options: + - latest + - nightly + - Version 1.9.x + - Version 1.8.x + - Version 1.7.x + - Different version + validations: + required: true + - type: dropdown + id: operating-system + attributes: + label: "💻 Operating System" + description: "What OS is your server / device running on?" + options: + - Linux + - MacOS + - Windows + validations: + required: true + - type: dropdown + id: browser-vendor + attributes: + label: "🌐 Browser" + description: "What browser are you running on?" + options: + - Firefox + - Chrome + - Edge + - Safari + - Other + validations: + required: true + - type: checkboxes + id: uses-docker + attributes: + label: "🐋 Docker" + options: + - label: "Currently running in Docker?" + required: false + validations: + required: true + - type: dropdown + id: nodejs-version + attributes: + label: "🟩 NodeJS Version" + description: "What version of NodeJS are you running?" + options: + - 14 + - 16 + - 17 + 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: no-duplicate-issues + attributes: + label: "👀 Have you spent some time to check if this issue has been raised before?" + description: "Please search in the issues without filters [here](https://github.com/louislam/uptime-kuma/issues?q=)" + options: + - label: "I checked and didn't find similar issue" + required: true From bdebbf8e40b7fdd4724c0f50a66da263430e779f Mon Sep 17 00:00:00 2001 From: Juan Calderon-Perez <835733+gaby@users.noreply.github.com> Date: Sun, 24 Oct 2021 00:40:06 -0400 Subject: [PATCH 2/4] Add Support for Issue Forms --- .github/ISSUE_TEMPLATE/ask-for-help.md | 21 ------ .github/ISSUE_TEMPLATE/ask-for-help.yaml | 79 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.yaml | 4 +- .github/ISSUE_TEMPLATE/feature_request.md | 22 ------ .github/ISSUE_TEMPLATE/feature_request.yaml | 45 ++++++++++++ 5 files changed, 127 insertions(+), 44 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/ask-for-help.md create mode 100644 .github/ISSUE_TEMPLATE/ask-for-help.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/ask-for-help.md b/.github/ISSUE_TEMPLATE/ask-for-help.md deleted file mode 100644 index 3031e077..00000000 --- a/.github/ISSUE_TEMPLATE/ask-for-help.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Ask for help -about: You can ask any question related to Uptime Kuma. -title: '' -labels: help -assignees: '' - ---- -**Is it a duplicated question?** -Please search in Issues without filters: https://github.com/louislam/uptime-kuma/issues?q= - -**Describe your problem** -Please describe what you are asking for - -**Info** -Uptime Kuma Version: -Using Docker?: Yes/No -Docker Version: -Node.js Version (Without Docker only): -OS: -Browser: diff --git a/.github/ISSUE_TEMPLATE/ask-for-help.yaml b/.github/ISSUE_TEMPLATE/ask-for-help.yaml new file mode 100644 index 00000000..41361e27 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ask-for-help.yaml @@ -0,0 +1,79 @@ +name: "❓ Ask for help" +description: "Submit any question related to Uptime Kuma" +title: "❓ Ask for help: " +labels: [help] +body: + - type: textarea + id: steps-to-reproduce + validations: + required: true + attributes: + label: "👟 Reproduction steps" + description: "Please walk us through it step by step." + placeholder: "Describe what are you asking for..." + - type: dropdown + id: uptime-kuma-version + attributes: + label: "🐻 Uptime-Kuma version" + description: "What version of Uptime-Kuma are you running?" + options: + - latest + - nightly + - Version 1.9.x + - Version 1.8.x + - Version 1.7.x + - Different version + validations: + required: true + - type: dropdown + id: operating-system + attributes: + label: "💻 Operating System" + description: "What OS is your server / device running on?" + options: + - Linux + - MacOS + - Windows + validations: + required: true + - type: dropdown + id: browser-vendor + attributes: + label: "🌐 Browser" + description: "What browser are you running on?" + options: + - Firefox + - Chrome + - Edge + - Safari + - Other + validations: + required: true + - type: checkboxes + id: uses-docker + attributes: + label: "🐋 Docker" + options: + - label: "Currently running in Docker?" + required: false + validations: + required: true + - type: dropdown + id: nodejs-version + attributes: + label: "🟩 NodeJS Version" + description: "If running in the host, Which version of NodeJS are you running?" + options: + - 14 + - 16 + - 17 + validations: + required: false + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "👀 Have you spent some time to check if this question has been raised before?" + description: "Please search in the issues without filters [here](https://github.com/louislam/uptime-kuma/issues?q=)" + options: + - label: "I checked and didn't find similar question" + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index acffc517..8d14c906 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -82,7 +82,7 @@ body: id: nodejs-version attributes: label: "🟩 NodeJS Version" - description: "What version of NodeJS are you running?" + description: "If running in the host, Which version of NodeJS are you running?" options: - 14 - 16 @@ -95,6 +95,8 @@ body: 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 + validations: + required: false - type: checkboxes id: no-duplicate-issues attributes: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 4794cc24..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -assignees: '' - ---- -**Is it a duplicated question?** -Please search in Issues without filters: https://github.com/louislam/uptime-kuma/issues?q= - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000..93c3fdfe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,45 @@ +name: 🚀 Feature +description: "Submit a proposal for a new feature" +title: "🚀 Feature: " +labels: [enhancement] +body: + - type: textarea + id: feature-description + validations: + required: true + attributes: + label: "🔖 Feature description" + description: "A clear and concise description of what the feature request is." + placeholder: "You should add ..." + - type: textarea + id: solution + validations: + required: true + attributes: + label: "✔️ Solution" + description: "A clear and concise description of what you want to happen." + placeholder: "In my use-case, ..." + - type: textarea + id: alternatives + validations: + required: false + attributes: + label: "❓ Alternatives" + description: "A clear and concise description of any alternative solutions or features you've considered." + placeholder: "I have considered ..." + - type: textarea + id: additional-context + validations: + required: false + attributes: + label: "❓ Additional Context" + description: "Add any other context or screenshots about the feature request here." + placeholder: "..." + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "👀 Have you spent some time to check if this feature request has been raised before?" + description: "Please search in the issues without filters [here](https://github.com/louislam/uptime-kuma/issues?q=)" + options: + - label: "I checked and didn't find similar feature request" + required: true \ No newline at end of file From 95342ec0066d2d3afeb7dc0ecc28e2bdfbf2a721 Mon Sep 17 00:00:00 2001 From: Juan Calderon-Perez <835733+gaby@users.noreply.github.com> Date: Sun, 24 Oct 2021 00:41:51 -0400 Subject: [PATCH 3/4] Update label for ask for help --- .github/ISSUE_TEMPLATE/ask-for-help.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/ask-for-help.yaml b/.github/ISSUE_TEMPLATE/ask-for-help.yaml index 41361e27..46f06d44 100644 --- a/.github/ISSUE_TEMPLATE/ask-for-help.yaml +++ b/.github/ISSUE_TEMPLATE/ask-for-help.yaml @@ -8,7 +8,7 @@ body: validations: required: true attributes: - label: "👟 Reproduction steps" + label: "📝 Describe your problem" description: "Please walk us through it step by step." placeholder: "Describe what are you asking for..." - type: dropdown From c489058a571d8d6f440cffec696fc92be34f03ac Mon Sep 17 00:00:00 2001 From: Juan Calderon-Perez <835733+gaby@users.noreply.github.com> Date: Sun, 24 Oct 2021 00:46:10 -0400 Subject: [PATCH 4/4] Update labels for each form --- .github/ISSUE_TEMPLATE/ask-for-help.yaml | 2 +- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yaml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/ask-for-help.yaml b/.github/ISSUE_TEMPLATE/ask-for-help.yaml index 46f06d44..0c77c262 100644 --- a/.github/ISSUE_TEMPLATE/ask-for-help.yaml +++ b/.github/ISSUE_TEMPLATE/ask-for-help.yaml @@ -1,6 +1,6 @@ name: "❓ Ask for help" description: "Submit any question related to Uptime Kuma" -title: "❓ Ask for help: " +title: "[Help]: " labels: [help] body: - type: textarea diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 8d14c906..53de8003 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -1,6 +1,6 @@ name: "🐛 Bug Report" description: "Submit a bug report to help us improve" -title: "🐛 Bug Report: " +title: "[Bug]: " labels: [bug] body: - type: markdown diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index 93c3fdfe..11260a28 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -1,6 +1,6 @@ name: 🚀 Feature description: "Submit a proposal for a new feature" -title: "🚀 Feature: " +title: "[Feature]: " labels: [enhancement] body: - type: textarea