Merge pull request #288 from canonical/issue-forms

Issue Forms

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,109 @@
+name: Bug Report
+description: Create an issue about a problem with the Snap
+title: "<title>"
+labels: [bug]
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: |
+      Please search to see if an issue already exists for the bug you encountered: https://github.com/canonical/steam-snap/issues?q=label%3Abug.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: checkboxes
+  attributes:
+    label: Have you checked the wiki for solutions?
+    description: |
+      Please check the wiki to see if your issue is addressed: https://github.com/canonical/steam-snap/wiki. If you do any troubleshooting from the wiki, please include it in the final section of this report.
+    options:
+    - label: I have searched the wiki
+      required: true
+- type: checkboxes
+  attributes:
+    label: Is this a Steam Snap-specific issue?
+    description: |
+      Please make sure your issue is exclusive to the Steam Snap and doesn't occur in the Steam deb. If this is a deb issue, then open an issue in Valve's repository instead: https://github.com/ValveSoftware/steam-for-linux. If you don't know or don't use the deb version of Steam, leave this unchecked.
+    options:
+    - label: This is a Steam Snap-specific issue
+      required: false
+- type: textarea
+  attributes:
+    label: Current Behavior
+    description: |
+      A concise description of what you're experiencing.
+    placeholder: |
+      A concise description of what you're experiencing.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Expected Behavior
+    description: |
+      A concise description of what you expected to happen.
+    placeholder: |
+      A concise description of what you expected to happen.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Steps To Reproduce
+    description: |
+      Steps to reproduce the behavior.
+    placeholder: |
+      1. Go to '...'
+      2. Click on '...'
+      3. Scroll down to '...'
+      4. See error/undesired behavior
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Environment
+    description: |
+      Output of `snap run steam.report --no-submit`. More info on this command [here](https://github.com/canonical/steam-snap/wiki/Troubleshooting#submitting-a-steam-report).
+    placeholder: |
+      os_release: 
+          name:               
+          version:            
+      snap_info: 
+          steam_revision:     
+          snapd_revision:     
+      lspci: 
+          00:00.0:                       
+      glxinfo: 
+          gpu:                
+          gpu_version:        
+      lscpu: 
+          model_name:         
+      xdg_current_desktop:    
+      desktop_session:        
+    render: yaml
+  validations:
+    required: true
+- type: dropdown
+  attributes:
+    label: gaming-graphics-core22 version
+    description: |
+      Please select the version(s) of the [gaming-graphics-core22](https://github.com/canonical/gaming-graphics/) Snap you have tried/this issue affects. More info on this [here](https://github.com/canonical/steam-snap/wiki/FAQ#how-do-i-use-a-different-mesagraphics-version).
+
+      If the issue is graphics/GPU related, it is very useful to us if you try each gaming-graphics-core22 branch and report observed behavior differences.
+    options:
+      - kisak-fresh (default)
+      - kisak-turtle
+      - oibaf-latest
+    multiple: true
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: |
+      Anything else?
+    description: |
+      Screenshots? [Logs](https://github.com/canonical/steam-snap/wiki/Troubleshooting#view-logs)? Links? Anything that will give us more context about the issue. If pasting logs, please format them by surrounding the text with ```.
+
+      Please include [Steam logs](https://github.com/canonical/steam-snap/wiki/Troubleshooting#view-logs) (if applicable) and any additional steps you took to troubleshoot. For troubleshooting ideas, see the [wiki](https://github.com/canonical/steam-snap/wiki).
+
+      Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+  validations:
+    required: false

.github/ISSUE_TEMPLATE/feature_reqest.yml

@@ -0,0 +1,39 @@
+name: Feature Request
+description: Suggest an idea for this project
+title: "<title>"
+labels: [enhancement]
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: |
+      Please search to see if an issue already exists for this feature: https://github.com/canonical/steam-snap/issues?q=label%3Aenhancement.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: textarea
+  attributes:
+    label: Is the feature related to a problem or existing issue?
+    description: |
+      If so, please describe the problem or reference/link the issue number. If not, leave this empty.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Describe the solution/feature you'd like.
+    description: |
+      Please note that we cannot provide any additional functionality to the Steam client itself. If this feature extends the Steam client functionality, open an issue in Valve's repository instead: https://github.com/ValveSoftware/steam-for-linux.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Describe any alternatives you've considered.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Additional context
+    description: |
+      Provide any additional context that may be relevant to the feature request.
+  validations:
+    required: false

.github/ISSUE_TEMPLATE/generic_issue.md

@@ -0,0 +1,14 @@
+---
+name: Generic Issue
+about: For issues that are not bugs or features
+title: ''
+labels: []
+assignees: ''
+---
+
+<!--
+If your issue is a bug, open a Bug Report instead.
+If your issue is a feature request, open a Feature Request instead.
+
+Otherwise, describe the issue below.
+-->