Merge pull request #1250 from hugoabernier/issue-template

Added issue templates
This commit is contained in:
Hugo Bernier 2020-04-26 13:04:14 -04:00 committed by GitHub
commit 3f45dbd94e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 202 additions and 0 deletions

76
.github/ISSUE_TEMPLATE/bug.md vendored Normal file
View File

@ -0,0 +1,76 @@
---
name: Bug
about: Report an anomaly or unexpected behavior with a sample from this repository.
title: ''
labels: ''
assignees: ''
---
> 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.
>
> Please note that issues that do not follow this template will automatically be rejected.
> ----
>
> 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)_
## Authors
> Because of the way this repository is configured, samples authors do not get a notification when you create an issue. *It makes it less likely for you to get your issue resolved or to get help*. 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. Use the `PREVIEW` tab at the top right to preview the rendering before submitting your issue.
>
> _(DELETE THIS PARAGRAPH AFTER READING)_
## Expected or Desired Behavior
> _Please describe the expected behavior._
>
> _(DELETE THIS PARAGRAPH AFTER READING)_
## Observed Behavior
> _If you are reporting a bug, please describe the behavior you expected to occur when performing the action. If you are making a suggestion, or sample request, you can delete this section._
>
> _(DELETE THIS PARAGRAPH AFTER READING)_
## 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:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
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)_
## 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.

1
.github/ISSUE_TEMPLATE/config.yaml vendored Normal file
View File

@ -0,0 +1 @@
blank_issues_enabled: false

57
.github/ISSUE_TEMPLATE/enhancement.md vendored Normal file
View File

@ -0,0 +1,57 @@
---
name: Enhancement
about: Suggest an enhancement to this repository or one of the samples
title: ''
labels: ''
assignees: ''
---
> 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.
>
> Please note that issues that do not follow this template will automatically be rejected.
> ----
>
> Thank you for suggesting an enhancement. 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)_
## Expected or Desired Behavior
> _Please describe thoroughly the enhancement, how it can be achieved, and the expected benefit. For sample requests, please explain what you'd like the sample to demonstrate._
>
> _(DELETE THIS PARAGRAPH AFTER READING)_
## Is your feature request related to a problem? Please describe.
> _A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]_
>
> _(DELETE THIS PARAGRAPH AFTER READING)_
## Describe the solution you'd like
> _A clear and concise description of what you want to happen._
>
> _(DELETE THIS PARAGRAPH AFTER READING)_
## Describe alternatives you've considered
> _A clear and concise description of any alternative solutions or features you've considered._
>
> _(DELETE THIS PARAGRAPH AFTER READING)_
## Additional context
> _If possible, add any other context or screenshots about the feature request here._
>
> _(DELETE THIS PARAGRAPH AFTER READING)_
## Guidelines for issue creator (DELETE AFTER READING)
> - All suggestions 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 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.

36
.github/ISSUE_TEMPLATE/question.md vendored Normal file
View File

@ -0,0 +1,36 @@
---
name: Question
about: Ask a question
title: ''
labels: ''
assignees: ''
---
> Use the following form to submit ask a question 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.
>
> Please note that issues that do not use this template will automatically be rejected.
> ----
>
> Thank you for asking a question. 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)_
## Authors
> Because of the way this repository is setup, samples authors do not get a notification when you create an issue. *It makes it less likely for you to get your issue resolved or to get help*. 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. Use the `PREVIEW` tab at the top right to preview the rendering before submitting your issue.
>
> _(DELETE THIS PARAGRAPH AFTER READING)_
## Guidelines for issue creator (DELETE AFTER READING)
> - All questions 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.

32
.github/ISSUE_TEMPLATE/samplerequest.md vendored Normal file
View File

@ -0,0 +1,32 @@
---
name: Sample request
about: Request a new sample from the community
title: ''
labels: ''
assignees: ''
---
> Thank you for suggesting a sample request. 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.
>
> Please note that issues that do not follow this template will automatically be rejected.
>
> _(DELETE THIS PARAGRAPH AFTER READING)_
## Expected or Desired Sample
> _Please explain what you'd like the sample to demonstrate.
>
> _(DELETE THIS PARAGRAPH AFTER READING)_
## Guidelines for issue creator (DELETE AFTER READING)
> - All sample requests 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 PARAGRAPH AFTER READING)_
Thanks for your contribution! Sharing is caring.