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

135 lines
4.5 KiB
YAML
Raw Normal View History

2021-04-24 12:35:06 -04:00
name: 🐞 Bug or Error Report
description: Report an anomaly or unexpected behavior with a sample from this repository.
title: "[Web Part Name]: [Issue Title]"
labels: ['Needs: Triage :mag:', 'type:bug-suspected']
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.
- 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.*
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 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 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:44:54 -04:00
- type: dropdown
validations:
required: true
attributes:
label: Target SharePoint environment
options:
- SharePoint Online
- SharePoint Server 2019 (on-premise)
- SharePoint Server 2016 (on-premise)
- type: dropdown
attributes:
label: Developer environment
options:
- Windows
- macOS
- Linux
2021-04-24 12:47:45 -04:00
- type: checkboxes
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)
- 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.
2021-04-24 12:44:54 -04:00
2021-04-24 12:33:01 -04:00
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
validations:
required: true
2021-04-24 12:40:23 -04:00
2021-04-24 12:33:01 -04:00
- type: dropdown
id: version
attributes:
label: Version
description: What version of our software are you running?
options:
- 1.0.2 (Default)
- 1.0.3 (Edge)
validations:
required: true
- type: dropdown
id: browsers
attributes:
label: What browsers are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
options:
- label: I agree to follow this project's Code of Conduct
2021-04-24 12:29:53 -04:00
required: true