sp-dev-fx-webparts/.github/ISSUE_TEMPLATE/bug-report.yml

162 lines
6.2 KiB
YAML
Raw Normal View History

2021-04-24 13:09:17 -04:00
name: 🐞 Bug or error report
2021-04-24 12:35:06 -04:00
description: Report an anomaly or unexpected behavior with a sample from this repository.
2021-11-07 15:25:11 -05:00
labels: ['type:bug-suspected']
2021-04-24 12:35:06 -04:00
2021-04-24 12:29:36 -04:00
body:
2021-04-24 12:36:36 -04:00
- 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.
2021-11-06 17:16:04 -04:00
> **IMPORTANT**
2022-03-12 16:39:53 -05:00
> Before you submit an issue, please follow the **[troubleshooting steps](https://github.com/pnp/sp-dev-fx-webparts/wiki/Troubleshooting-issues-with-samples)**.
2021-11-06 17:14:44 -04:00
2021-04-24 12:36:36 -04:00
- 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!
2021-04-24 13:49:39 -04:00
- This repo is maintained by volunteers. Please be courteous and patient. 🙂
2021-04-24 12:36:36 -04:00
- Remember to include sufficient details and context.
- If you have multiple questions, suggestions, or bugs, please submit them in separate issues.
2021-04-24 13:41:06 -04:00
- We accept pull requests. If you know how to fix it - go ahead! If you know how to make it - go ahead! If you're unsure how to do a pull request, consider signing up for a free [Sharing is Caring First-Time Contributor](http://aka.ms/sharing-is-caring#pnp-sic-first-time-contributor) session.
2021-04-24 12:36:36 -04:00
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.*
2022-03-12 16:39:53 -05:00
- type: checkboxes
id: disclaimer
validations:
required: true
attributes:
label: I have reviewed the **[troubleshooting steps](https://github.com/pnp/sp-dev-fx-webparts/wiki/Troubleshooting-issues-with-samples)** and [how to create good issues](https://github.com/pnp/sp-dev-fx-webparts/wiki/How-to-Create-Good-Issues) before submitting this issue and understand that my issue may be closed if I do not follow the guidelines.
2021-04-24 12:29:53 -04:00
- type: input
2021-04-24 12:38:32 -04:00
id: sample
2021-04-24 12:40:23 -04:00
validations:
required: true
2021-04-24 12:33:01 -04:00
attributes:
2021-04-24 12:38:32 -04:00
label: Sample
description: |
Which sample are you having troubles with?
Use the sample name or URL. We don't want to be spend all this time diagnosing issues about the wrong sample, do we?
2021-04-24 12:40:23 -04:00
- type: input
2021-04-24 13:08:19 -04:00
id: authors
2021-04-24 12:40:59 -04:00
validations:
required: true
attributes:
2021-04-24 12:41:54 -04:00
label: Author(s)
2021-04-24 12:40:59 -04:00
description: |
2021-04-24 12:41:54 -04:00
Who wrote the sample?
2021-04-24 12:40:23 -04:00
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.
2021-04-24 13:49:39 -04:00
Issues without an @mention will be closed automatically, as authors won't get notified.
2021-04-24 12:41:54 -04:00
**NOTE:** Don't @mention the repo maintainers, they already get notified.
2021-04-24 12:40:23 -04:00
2021-04-24 12:57:01 -04:00
- 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
id: what-happened
attributes:
label: What happened?
2021-04-24 13:00:03 -04:00
description: Describe the observed behavior
2021-04-24 12:57:01 -04:00
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
2021-04-24 13:08:19 -04:00
id: steps
2021-04-24 12:57:01 -04:00
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
2021-04-24 13:08:19 -04:00
id: expected
2021-04-24 12:57:01 -04:00
attributes:
label: Expected behavior
description: What did you expect to happen when the reproduce steps are followed?
2021-04-24 13:00:03 -04:00
placeholder: Tell us what you expected to see!
2021-04-24 12:57:01 -04:00
validations:
required: true
2021-04-24 13:05:20 -04:00
- type: markdown
attributes:
value: |
When solving bugs, most time is spent going back and forth with the issue author asking for more information about their environment.
Save yourself some time (and those who are trying to help you); provide us with your environment information so we can reproduce the issue.
2021-04-24 13:06:01 -04:00
We're not trying to be difficult here, we just want to help as quickly as possible.
2021-04-24 13:05:20 -04:00
2021-04-24 12:44:54 -04:00
- type: dropdown
2021-04-24 13:08:19 -04:00
id: sharepoint-version
2021-04-24 12:44:54 -04:00
validations:
required: true
attributes:
label: Target SharePoint environment
options:
- SharePoint Online
- SharePoint Server 2019 (on-premise)
- SharePoint Server 2016 (on-premise)
- type: dropdown
2021-04-24 13:08:19 -04:00
id: environment-os
2021-04-24 12:44:54 -04:00
attributes:
label: Developer environment
options:
- Windows
- macOS
- Linux
2021-04-24 12:47:45 -04:00
- type: checkboxes
2021-04-24 13:08:19 -04:00
id: browsers
2021-04-24 12:47:45 -04:00
attributes:
2021-04-24 12:48:51 -04:00
label: Browsers
description: |
What browser(s) / client(s) have you tested
Select the browser(s)/clients this submission is relevant to.
2021-04-24 12:47:45 -04:00
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)
2022-03-12 16:39:53 -05:00
- type: textarea
id: spfxdoctor
2021-04-24 12:52:43 -04:00
validations:
required: true
2021-04-24 12:57:01 -04:00
attributes:
2022-03-12 16:39:53 -05:00
label: Paste the results of SPFx doctor
2021-04-24 12:57:01 -04:00
description: |
2022-03-12 16:39:53 -05:00
Run `m365 spfx doctor -o json` and paste the results.
2021-04-24 12:57:01 -04:00
2022-03-12 16:39:53 -05:00
Follow [the steps](https://github.com/pnp/sp-dev-fx-webparts/wiki/Troubleshooting-issues-with-samples#run-spfx-doctor) listed in [troubleshooting issues with samples](https://github.com/pnp/sp-dev-fx-webparts/wiki/Troubleshooting-issues-with-samples)
2021-04-24 13:05:20 -04:00
- type: textarea
2021-04-24 13:08:19 -04:00
id: moar
2021-04-24 13:05:20 -04:00
attributes:
label: Additional environment details
description: Include as much detail about the environment you're targeting. This is required if "other (enter below)" is selected in the previous field.