Create bug-report.yml

2021-04-24 12:21:44 -04:00 · 2021-04-24 12:21:44 -04:00 · 0507d0a707
parent a4578b473c
commit 0507d0a707
1 changed files with 116 additions and 0 deletions
--- a/.github/ISSUE_TEMPLATE/bug-report.yml
+++ b/.github/ISSUE_TEMPLATE/bug-report.yml
@ -0,0 +1,116 @@
+name: 🐞 Bug or Error Report
+description: Report an anomaly or unexpected behavior with a sample from this repository.
+labels: ['Needs: Triage :mag:', 'type:bug-suspected']
+
+body:
+- type: markdown
+  attributes:
+    value: |
+      - [x] Bug
+
+      Thank you for reporting a bug! Use the sections below to submit a bug ONLY if it's related to samples in this repo. If you have an issue or question about the SharePoint Framework or its documentation, please submit it at https://aka.ms/spdev-issues. 
+      
+      - Follow our guidance on [How To Create Good Issues](https://github.com/pnp/sp-dev-fx-webparts/wiki/How-to-Create-Good-Issues).
+      - All bug reports are welcome - we want to fix them!
+      - This repo is maintained by volunteers (not Microsoft). Please be courteous and patient. 🙂
+      - Remember to include sufficient details and context.
+      - If you have multiple questions, suggestions, or bugs, please submit them in separate issues.
+      - We accept pull requests. If you know how to fix it - go ahead!
+
+      Please provide the following details about the issue you encountered.  *Issues that do not provide the information requested in this form will be flagged as **incomplete** & automatically closed.*
+
+ - type: input
+    validations:
+      required: true
+    attributes:
+      label: Which sample are you having troubles with?
+      description: >
+        Use the sample name or URL. We don't want to be spend all this time diagnosing issues about the wrong sample, do we?
+
+ - type: input
+    validations:
+      required: true
+    attributes:
+      label: Authors
+      description: |
+        Because of the way this repository is configured, samples authors do not get a notification when you create an issue. 
+        
+        For the section above **@mention any author of the sample**. Authors' GitHub handle can be found on the main sample documentation page, under the "Solution" section. 
+        
+        Don't @mention the repo maintainers, they already get notified.
+
+- type: dropdown
+  attributes:
+    label: Target SharePoint environment
+    options:
+      - SharePoint Online
+      - SharePoint Server 2019 (on-premise)
+      - SharePoint Server 2016 (on-premise)
+  validations:
+    required: true
+
+- type: dropdown
+  attributes:
+    label: Developer environment
+    options:
+      - Windows
+      - macOS
+      - Linux
+
+- type: checkboxes
+  attributes:
+    label: What browser(s) / client(s) have you tested
+    description: |
+      Select the browser(s)/clients this submission is relevant to.
+
+    options:
+      - label: Internet Explorer
+      - label: Microsoft Edge
+      - label: Google Chrome
+      - label: FireFox
+      - label: Safari
+      - label: mobile (iOS/iPadOS)
+      - label: mobile (Android)
+      - label: not applicable
+      - label: other (enter in the "Additional environment details" area below)
+
+- type: textarea
+  attributes:
+    label: Additional environment details
+    description: Include as much detail about the environment you're targetting. This is required if "other (enter below)" is selected in the previous field.
+    value: |
+      - browser version
+      - SPFx version
+      - Node.js version
+      - etc
+
+- type: markdown
+  attributes:
+    value: |
+      Provide a clear & concise description of what the bug is. Please follow our guidance on [How To Create Good Issues](https://github.com/pnp/sp-dev-fx-webparts/wiki/How-to-Create-Good-Issues) which explains how to apply formatting, adding references & resources, screenshots, etc. 
+      
+      **Do not attach ZIP files** of your code or compiled projects - instead, please publish your code to a public GitHub repo & post a link to it.
+
+- type: textarea
+  attributes:
+    label: Describe the observed behavior
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Steps to reproduce
+    description: How do you reproduce this? Please provide as much step-by-step detail as possible.
+    value: |
+      1.
+      2.
+      3.
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Expected behavior
+    description: What did you expect to happen when the reproduce steps are followed?
+  validations:
+    required: true