Update bug.md

Updated bug template to match sp-dev-list-formatting and because we all want to be more like @thechriskent
This commit is contained in:
Hugo Bernier 2020-05-24 11:51:54 -04:00 committed by GitHub
parent 3bba69d902
commit 11edb6dde8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 50 deletions

View File

@ -7,21 +7,19 @@ assignees: ''
--- ---
> Please note that issues that do not follow this template will automatically be rejected. 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 list formatting or its documentation, please submit it at https://aka.ms/spdev-issues
>
> Use the following form to submit an issue only if it's related to samples in this repo. If you have an issue related to the SharePoint Framework or its documentation, please submit the issue at [https://github.com/SharePoint/sp-dev-docs/issues/new](https://github.com/SharePoint/sp-dev-docs/issues/new). This will help us respond to your issue faster.
>
> ----
>
> Thank you for reporting an issue. We appreciate your feedback - to help the team to understand your needs, please complete the below template to ensure we have the necessary details to assist you.
>
> _(DELETE THIS PARAGRAPH AFTER READING)_
## Sample - Bugs that do not follow the below template will automatically be closed
- All bug reports are welcome - we want to fix them!
- This repo is maintained by volunteers (not Microsoft). Please be courteous and patient. 🙂
- Include sufficient details and context.
- If you have multiple bugs please submit them separately so we can track resolution.
- Screenshots are always helpful (just paste any images right here in the bug report)
- We accept pull requests. If you know how to fix it - go ahead!
> Please specify which sample this is regarding. DELETE EVERYTHING ABOVE AFTER READING - THANKS!
>
> _(DELETE THIS PARAGRAPH AFTER READING)_ ## Sample (which sample are you having trouble with)
## Authors ## Authors
@ -31,20 +29,11 @@ assignees: ''
## Expected or Desired Behavior ## Expected or Desired Behavior
> _Please describe the expected behavior._
>
> _(DELETE THIS PARAGRAPH AFTER READING)_
## Observed Behavior ## Observed Behavior
> _Please describe the behavior you expected to occur when performing the action._
>
> _(DELETE THIS PARAGRAPH AFTER READING)_
## Steps to Reproduce ## Steps to Reproduce
> _Describe the steps to reproduce the bug in sufficient detail to allow testing. The only way to fix things properly is to have sufficient details to reproduce it._
>
> _(DELETE THIS PARAGRAPH AFTER READING)_
Steps to reproduce the behavior: Steps to reproduce the behavior:
1. Go to '...' 1. Go to '...'
@ -52,21 +41,8 @@ Steps to reproduce the behavior:
3. Scroll down to '....' 3. Scroll down to '....'
4. See error 4. See error
## Expected behavior
> A clear and concise description of what you expected to happen.
>
> _(DELETE THIS PARAGRAPH AFTER READING)_
## Screenshots
> **OPTIONAL**
> If applicable, add screenshots to help explain your problem.
>
> _(DELETE THIS PARAGRAPH AFTER READING)_
# Environment Details (*Development & Target environment*) # Environment Details (*Development & Target environment*)
> **DELETE THIS LINE BEFORE SUBMITTING** - Complete the following (*if ignored you'll be prompted for it before we can address your issue... save the time and provide it in your initial submission*).
- **OS**: [e.g. Windows 10 | MacOS 10.15.x] - **OS**: [e.g. Windows 10 | MacOS 10.15.x]
- **Target Environment**: [e.g. SharePoint Server 2016 | SharePoint Server 2019 | SharePoint Online] - **Target Environment**: [e.g. SharePoint Server 2016 | SharePoint Server 2019 | SharePoint Online]
- **Framework**: [e.g. .NET Framework v3.x | .NET Core v3.x | Node.js v6/v8/v10/v12] - **Framework**: [e.g. .NET Framework v3.x | .NET Core v3.x | Node.js v6/v8/v10/v12]
@ -75,20 +51,5 @@ Steps to reproduce the behavior:
- **Additional details**: *The more context you can provide, the easier it is (and therefore quicker) to help.* - **Additional details**: *The more context you can provide, the easier it is (and therefore quicker) to help.*
## Additional context ## Additional context
> **OPTIONAL**
> Add any other context about the problem here.
>
> _(DELETE THIS PARAGRAPH AFTER READING)_
## Guidelines for issue creator (DELETE AFTER READING)
> - All bug reports are welcome, please let us know what's on your mind.
> - Remember that this repository is maintained by community members who volunteer their time to help. Be courteous and patient.
> - If you are reporting an issue around any of the samples, please ensure that you have a clear reference to the sample and possibly code file, which should be fixed.
> - If you have technical questions about the framework, well be monitoring #spfx, #spfx-webparts, and #spfx-tooling on (SharePoint StackExchange)> [http://sharepoint.stackexchange.com/]. You can also alternatively submit your question to (SharePoint Developer group)> [https://techcommunity.microsoft.com/t5/sharepoint-developer/bd-p/SharePointDev] in the Microsoft Tech Community.
> - Remember to include sufficient details and context.
> - If you have multiple suggestions or bugs please submit them in separate bugs so we can track resolution.
> _(DELETE THIS SECTION AFTER READING)_
Thanks for your contribution! Sharing is caring.