Add new issue templates for bugs

Replace the old issue template with two new issue forms to help guide contributors through the issue creation Signed-off-by: Ekaterina Gerasimova <kittykat3756@gmail.com>
2024-10-01 01:26:12 -04:00 · 2021-08-06 09:00:08 +01:00 · 2021-08-06 09:00:08 +01:00 · 8480dbb726
commit 8480dbb726
parent 66c86697c1
3 changed files with 116 additions and 58 deletions
--- a/.github/ISSUE_TEMPLATE/bug-desktop.yml
+++ b/.github/ISSUE_TEMPLATE/bug-desktop.yml
@ -0,0 +1,54 @@
+name: Bug report for the Element desktop app (not in a browser)
+description: File a bug report if you are using the desktop Element application.
+title: "[Bug]: "
+labels: [T-Defect, triage]
+assignees:
+  -   
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+
+        Please report security issues by email to security@matrix.org
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: Steps to reproduce
+      description: Please attach screenshots, videos or logs if you can.
+      placeholder: Tell us what you see!
+      value: |
+        1. Where are you starting? What can you see?
+        2. What do you click?
+        3. More steps…
+    validations:
+      required: true
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      placeholder: Tell us what went wrong
+    validations:
+      required: true
+  - type: textarea
+    id: expected-result
+    attributes:
+      label: What did you expect?
+      placeholder: Tell us what you expected to happen
+    validations:
+      required: true
+  - type: input
+    id: os
+    attributes:
+      label: Operating system
+      placeholder: Windows, macOS, Ubuntu, Arch Linux…
+    validations:
+      required: false
+  - type: input
+    id: version
+    attributes:
+      label: Application version
+      description: You can find the version information in Settings -> Help & About. 
+      placeholder: e.g. Element version 1.7.34, olm version 3.2.3 
+    validations:
+      required: false
--- a/.github/ISSUE_TEMPLATE/bug-web.yml
+++ b/.github/ISSUE_TEMPLATE/bug-web.yml
@ -0,0 +1,62 @@
+name: Bug report for Element Web (in browser)
+description: File a bug report if you are using Element in a web browser like Firefox, Chrome, Edge, and so on.
+title: "[Bug]: "
+labels: [T-Defect, triage]
+assignees:
+  -   
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+
+        Please report security issues by email to security@matrix.org
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: Steps to reproduce
+      description: Please attach screenshots, videos or logs if you can.
+      placeholder: Tell us what you see!
+      value: |
+        1. Where are you starting? What can you see?
+        2. What do you click?
+        3. More steps…
+    validations:
+      required: true
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      placeholder: Tell us what went wrong
+    validations:
+      required: true
+  - type: textarea
+    id: expected-result
+    attributes:
+      label: What did you expect?
+      placeholder: Tell us what you expected to happen
+    validations:
+      required: true
+  - type: input
+    id: os
+    attributes:
+      label: Operating system
+      placeholder: Windows, macOS, Ubuntu, Arch Linux…
+    validations:
+      required: false
+  - type: input
+    id: browser
+    attributes:
+      label: Browser information
+      description: Which browser are you using? Which version? 
+      placeholder: e.g. Chromium Version 92.0.4515.131
+    validations:
+      required: false
+  - type: input
+    id: webapp-url
+    attributes:
+      label: URL for webapp
+      description: Which URL are you using to access the webapp? If a private server, tell us what version of Element Web you are using.
+      placeholder: e.g. develop.element.io, app.element.io
+    validations:
+      required: false
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@ -1,58 +0,0 @@
---
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: T-Defect
-assignees: ''
-
---
-
-<!-- A picture's worth a thousand words: PLEASE INCLUDE A SCREENSHOT :P -->
-
-<!-- Please report security issues by email to security@matrix.org -->
-
-<!-- This is a bug report template. By following the instructions below and
-filling out the sections with your information, you will help the us to get all
-the necessary data to fix your issue.
-
-You can also preview your report before submitting it. You may remove sections
-that aren't relevant to your particular case.
-
-Text between <!-- and --> marks will be invisible in the report.
-->
-
-#### Description
-
-Describe here the problem that you are experiencing, or the feature you are requesting.
-
-#### Steps to reproduce
-
- For bugs, list the steps
- that reproduce the bug
- using hyphens as bullet points
-
-Describe how what happens differs from what you expected.
-
-<!-- Please send us logs for your bug report. They're very important for bugs
-which are hard to reproduce. To do this, create this issue then go to your
-account settings and click 'Submit Debug Logs' from the Help & About tab -->
-Logs being sent: yes/no
-
-<!-- Include screenshots if possible: you can drag and drop images below. -->
-
-#### Version information
-
-<!-- IMPORTANT: please answer the following questions, to help us narrow down the problem -->
-
- **Platform**: web (in-browser) or desktop?
-
-For the web app:
-
- **Browser**: Chrome, Firefox, Safari, Edge? which version?
- **OS**: Windows, macOS, Ubuntu, Arch Linux, etc?
- **URL**: develop.element.io / app.element.io / somewhere else? If a private server, what version of Element Web?
-
-For the desktop app:
-
- **OS**: Windows, macOS, Ubuntu, Arch Linux, etc?
- **Version**: 1.x.y <!-- check the user settings panel if unsure -->