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..dd1bcaf7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ask-for-help.yaml @@ -0,0 +1,76 @@ +name: "❓ Ask for help" +description: "Submit any question related to Uptime Kuma" +title: "[Help]: <title>" +labels: [help] +body: + - type: textarea + id: steps-to-reproduce + validations: + required: true + attributes: + label: "📝 Describe your problem" + description: "Please walk us through it step by step." + placeholder: "Describe what are you asking for..." + - type: input + id: uptime-kuma-version + attributes: + label: "🐻 Uptime-Kuma version" + description: "Which version of Uptime-Kuma are you running?" + placeholder: "Ex. 1.9.x" + validations: + required: true + - type: input + id: operating-system + attributes: + label: "💻 Operating System" + description: "Which OS is your server/device running on?" + placeholder: "Ex. Ubuntu 20.04" + validations: + required: true + - type: input + id: browser-vendor + attributes: + label: "🌐 Browser" + description: "Which browser are you running on?" + placeholder: "Ex. Firefox" + validations: + required: true + - type: input + id: docker-version + attributes: + label: "🐋 Docker" + description: "If running with Docker, which version are you running?" + placeholder: "Ex. 20.10.9" + validations: + required: false + - type: input + id: docker-image-tag + attributes: + label: "🏷️ Docker Image Tag" + description: "Which Docker image tag are you using? If running '1' or 'latest', please specify image hash." + placeholder: "Ex. 1.9.1" + validations: + required: false + - type: input + id: nodejs-version + attributes: + label: "🟩 NodeJS Version" + description: "If running with Node.js? which version are you running?" + placeholder: "14.x" + 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 + - type: checkboxes + attributes: + label: "🛡️ Security Policy" + description: Please review the security policy before reporting security related issues/bugs. + options: + - label: I agree to have read this project [Security Policy](https://github.com/louislam/uptime-kuma/security/policy) + required: true 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 <container id>` -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..5e3b5bf8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,100 @@ +name: "🐛 Bug Report" +description: "Submit a bug report to help us improve" +title: "[Bug]: <title>" +labels: [bug] +body: + - 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: input + id: uptime-kuma-version + attributes: + label: "🐻 Uptime-Kuma version" + description: "Which version of Uptime-Kuma are you running?" + placeholder: "Ex. 1.9.x" + validations: + required: true + - type: input + id: operating-system + attributes: + label: "💻 Operating System" + description: "Which OS is your server/device running on?" + placeholder: "Ex. Ubuntu 20.04" + validations: + required: true + - type: input + id: browser-vendor + attributes: + label: "🌐 Browser" + description: "Which browser are you running on?" + placeholder: "Ex. Firefox" + validations: + required: true + - type: input + id: docker-version + attributes: + label: "🐋 Docker" + description: "If running with Docker, which version are you running?" + placeholder: "Ex. 20.10.9" + validations: + required: false + - type: input + id: docker-image-tag + attributes: + label: "🏷️ Docker Image Tag" + description: "Which Docker image tag are you using? If running '1' or 'latest', please specify image hash." + placeholder: "Ex. 1.9.1" + validations: + required: false + - type: input + id: nodejs-version + attributes: + label: "🟩 NodeJS Version" + description: "If running with Node.js? which version are you running?" + placeholder: "14.x" + 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 + validations: + required: false + - 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 + - type: checkboxes + attributes: + label: "🛡️ Security Policy" + description: Please review the security policy before reporting security related issues/bugs. + options: + - label: I agree to have read this project [Security Policy](https://github.com/louislam/uptime-kuma/security/policy) + required: true 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..bca32552 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,59 @@ +name: 🚀 Feature Request +description: "Submit a proposal for a new feature" +title: "[Feature]: <title>" +labels: [enhancement] +body: + - type: dropdown + id: feature-area + attributes: + label: "🏷️ Feature Request Type" + description: "What kind of feature request is this?" + multiple: true + options: + - API + - New Notification + - New Monitor + - UI Feature + - Other + validations: + required: true + - 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