From 0c1d04919f0e6a64141abdbb01af1e2e2ab2c981 Mon Sep 17 00:00:00 2001 From: Schalk Neethling Date: Sun, 2 Oct 2022 16:20:16 +0200 Subject: [PATCH] :paperclip: Switch to issue forms (on github) GitHub launched issue template forms some time ago. These have helped other open source projects I have been involved in. As you can make certain fields required, it also helps cut down on issue spam. fix #2395 --- .github/ISSUE_TEMPLATE/bug-report.yml | 89 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 72 ----------------- .github/ISSUE_TEMPLATE/feature-request.yml | 37 +++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 21 ----- 4 files changed, 126 insertions(+), 93 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..67ba1d4fe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,89 @@ +description: Create a report to help us improve +labels: ["bug"] +name: Bug report +title: "bug: " +body: + - type: markdown + attributes: + value: | + ## Before you start + + Please search our [existing issues](https://github.com/penpot/penpot/issues) and open [pull requests](https://github.com/penpot/penpot/pulls) to lessen the change of filing duplicate issues or feature requests. Thank you. + + --- + - type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + Steps to reproduce the behavior: + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + validations: + required: true + - type: textarea + id: expected + attributes: + description: A clear and concise description of what you expected to happen. + label: Expected behavior + validations: + required: true + - type: textarea + id: actual + attributes: + description: A clear and concise description of what happens instead; what the bug is. + label: Actual behavior + validations: + required: true + - type: textarea + id: screenshots + attributes: + description: If applicable, add screenshots to help explain your problem. + label: Screenshots or video + - type: textarea + id: desktop + attributes: + label: Desktop (please complete the following information) + placeholder: | + - OS (e.g. iOS): + - Browser & version (e.g. Chrome 89.0): + - type: textarea + id: mobile + attributes: + label: Smartphone (please complete the following information) + placeholder: | + - Device & model (e.g. iPhone 6): + - OS & version (e.g. iOS 8.1): + - Browser & version (e.g. stock browser 22): + - type: textarea + id: environment + attributes: + label: Environment (please complete the following information) + placeholder: | + - Host (e.g. https://design.penpot.app, local instance): + + *If self-hosted:* + - OS Version (e.g. Ubuntu 16.04): + - Docker / Docker-compose version (e.g. Docker version 18.03.0-ce, build 0520e24): + - Image version (e.g. Alpine): + + Docker commands or docker-compose file (if possible and if proceed.x): + ``` + + ``` + - type: textarea + id: frontend-trace + attributes: + label: Frontend Stack Trace + render: console + - type: textarea + id: backend-trace + attributes: + label: Backend Stack Trace + render: console + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Any other context about the problem. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index bdbe87a01..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,72 +0,0 @@ ---- - -name: Bug report -about: Create a report to help us improve -title: '' -labels: bug -assignees: '' - ---- - -**To Reproduce** - -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' - -**Expected behavior** - -A clear and concise description of what you expected to happen. - -**Actual behavior** - -A clear and concise description of what happens instead; what the bug is. - -**Screenshots** - -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** -- OS (e.g. iOS): -- Browser & version (e.g. Chrome 89.0): - -**Smartphone (please complete the following information):** -- Device & model (e.g. iPhone 6): -- OS & version (e.g. iOS 8.1): -- Browser & version (e.g. stock browser 22): - -**Environment (please complete the following information):** -- Host (e.g. https://design.penpot.app, local instance): - -*If self-hosted:* -- OS Version (e.g. Ubuntu 16.04): -- Docker / Docker-compose version (e.g. Docker version 18.03.0-ce, build 0520e24): -- Image version (e.g. Alpine): - -Docker commands or docker-compose file (if possible and if proceed.x): -``` - -``` - -Frontend Stack Trace: -
- -``` - -``` - -
- -Backend Stack Trace: -
- -``` - -``` - -
- -**Additional context:** - -Any other context about the problem. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000..a49d6a57c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,37 @@ +description: Suggest an idea for this project. +labels: ["needs triage", "enhancement"] +name: "Feature request" +title: "feature: " +body: + - type: markdown + attributes: + value: | + ## Before you start + + Please search our [existing issues](https://github.com/penpot/penpot/issues) and open [pull requests](https://github.com/penpot/penpot/pulls) to lessen the change of filing duplicate issues or feature requests. Thank you. + + --- + - type: textarea + id: problem + attributes: + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when (...) + label: Is your feature request related to a problem? Please describe. + validations: + required: true + - type: textarea + id: solution + attributes: + description: A clear and concise description of what you want to happen. + label: Describe the solution you'd like. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered. + description: A clear and concise description of any alternative solutions or features you've considered. + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index f98a4e747..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,21 +0,0 @@ ---- - -name: Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -assignees: '' - ---- - -**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.