Issue template (#1569)

2024-11-21 12:05:42 +01:00 · 2021-09-09 11:53:48 +02:00 · 2021-09-09 11:53:48 +02:00 · d977d27d7d
commit d977d27d7d
parent d07a68e3cc
3 changed files with 87 additions and 57 deletions
--- a/.github/ISSUE_TEMPLATE/bug.yml
+++ b/.github/ISSUE_TEMPLATE/bug.yml
@ -0,0 +1,73 @@
+name: Bug Report
+description: File a bug report
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+        
+        Please do not submit feature requests. The [Community Forums](https://community.bitwarden.com) has a section for submitting, voting for, and discussing product feature requests.
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps To Reproduce
+      description: How can we reproduce the behavior.
+      value: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. Click on '...'
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Result
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual Result
+      description: A clear and concise description of what is happening.
+    validations:
+      required: true
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots or Videos
+      description: If applicable, add screenshots and/or a short video to help explain your problem.
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Add any other context about the problem here.
+  - type: input
+    id: version
+    attributes:
+      label: Build Version
+      description: What version of our software are you running?
+    validations:
+      required: true
+  - type: dropdown
+    id: environment
+    attributes:
+      label: Environment
+      description: Which environment (Cloud / Self-Hosted) are you using?
+      multiple: true
+      options:
+        - Cloud (bitwarden.com)
+        - Self-Hosted
+    validations:
+      required: true
+  - type: textarea
+    id: environment-details
+    attributes:
+      label: Environment Details
+      description: If Self-Hosted please provide some additional environment details.
+      placeholder: |
+        - Operating system: [e.g. Windows 10, Mac OS Catalina]
+        - Environment: [e.g. Docker, EKS, ECS, K8S]
+        - Hardware: [e.g. Intel 6-core, 8GB RAM]
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@ -0,0 +1,14 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Feature Requests
+    url: https://community.bitwarden.com/c/feature-requests/
+    about: Request new features using the Community Forums. Please search existing feature requests before making a new one.
+  - name: Bitwarden Community Forums
+    url: https://community.bitwarden.com
+    about: Please visit the community forums for general community discussion, support and the development roadmap.
+  - name: Customer Support
+    url: https://bitwarden.com/contact/
+    about: Please contact our customer support for account issues and general customer support.
+  - name: Security Issues
+    url: https://hackerone.com/bitwarden
+    about: We use HackerOne to manage security disclosures.
--- a/ISSUE_TEMPLATE.md
+++ b/ISSUE_TEMPLATE.md
@ -1,57 +0,0 @@
-<!--
-Please do not submit feature requests. The [Community Forums][1]
-has a section for submitting, voting for, and discussing product
-feature requests.
-[1]: https://community.bitwarden.com
-
-Please remove HTML comments before finalizing your submission.
-->
-
-## Describe the Bug
-
-<!-- Comment:
-A clear and concise description of what the bug is.
-->
-
-## Steps To Reproduce
-
-<!-- Comment:
-How can we reproduce the behavior:
-->
-
-1. HTTP GET to '...'
-2. Copy response and HTTP POST to '....'
-3. Run command '....' via CLI
-4. Validate response has '...'
-
-## Expected Result
-
-<!-- Comment:
-A clear and concise description of what you expected to happen.
-->
-
-## Actual Result
-
-<!-- Comment:
-A clear and concise description of what is happening.
-->
-
-## Screenshots or Videos
-
-<!-- Comment:
-If applicable, add screenshots and/or a short video to help explain your problem.
-->
-
-## Environment
-
- Operating system: [e.g. Cloud, Windows 10, Mac OS Catalina]
- Build Version: [e.g. 1.42.0]
- Self Hosted: [true/false]
- Environment: [e.g. Cloud, Docker, EKS, ECS, K8S]
- Hardware: [e.g. Intel 6-core, 8GB RAM]
-
-## Additional Context
-
-<!-- Comment:
-Add any other context about the problem here.
-->