Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
Updated issue templates to make sp-dev-fx-webparts and sp-dev-lists
  • Loading branch information
hugoabernier authored May 24, 2020
1 parent d8acc15 commit f3480eb
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 95 deletions.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/---suggestion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: "\U0001F4A1 Suggestion"
about: Suggest an enhancement to make one of our web part samples even better
title: ''
labels: type:enhancement
assignees: ''

---

Thank you for your suggestion! Use the sections below to submit a suggestion 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

- Suggestions that do not follow the below template will automatically be closed
- All ideas are welcome - let's build something together!
- This repo is maintained by volunteers (not Microsoft). Please be courteous and patient. 🙂
- Include sufficient details and context.
- If you have multiple suggestions please submit them separately so we can track resolution.
- Screenshots are always helpful (just paste any images right here in the suggestion)

DELETE EVERYTHING ABOVE AFTER READING - THANKS!

## Sample (which sample are you talking about)


## 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**. The 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)_
## Suggestion (the more details, the better)
63 changes: 11 additions & 52 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,19 @@ assignees: ''

---

> Please note that issues that do not follow this template will automatically be rejected.
>
> 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)_
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

## 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 THIS PARAGRAPH AFTER READING)_
DELETE EVERYTHING ABOVE AFTER READING - THANKS!

## Sample (which sample are you having trouble with)

## Authors

Expand All @@ -31,42 +29,20 @@ assignees: ''
## Expected or Desired Behavior

> _Please describe the expected behavior._
>
> _(DELETE THIS PARAGRAPH AFTER READING)_

## Observed Behavior

> _Please describe the behavior you expected to occur when performing the action._
>
> _(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)_
# 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]
- **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]
Expand All @@ -75,20 +51,3 @@ Steps to reproduce the behavior:
- **Additional details**: *The more context you can provide, the easier it is (and therefore quicker) to help.*

## 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, we’ll 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.
39 changes: 15 additions & 24 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,25 @@
---
name: "❓ Question"
about: Ask a question regarding one of the samples in this repository
about: Ask a question about one of our extension samples
title: ''
labels: ''
labels: type:question
assignees: ''

---

> Please note that issues that do not follow this template will automatically be rejected.
>
> 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.
>
> ----
>
> 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)_
Thank you for asking a question! Use the sections below to submit a question 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

## Sample
- Questions that do not follow the below template will automatically be closed
- All questions are welcome - let us know what's on your mind!
- This repo is maintained by volunteers (not Microsoft). Please be courteous and patient. 🙂
- Include sufficient details and context.
- If you have multiple questions please submit them separately so we can track resolution.
- Screenshots are always helpful (just paste any images right here in the question)

DELETE EVERYTHING ABOVE AFTER READING - THANKS!

## Sample (which sample are you talking about)

> Please specify which sample this is regarding.
>
> _(DELETE THIS PARAGRAPH AFTER READING)_

## Authors

Expand All @@ -30,14 +28,7 @@ assignees: ''
> _(DELETE THIS PARAGRAPH AFTER READING)_

## Guidelines for issue creator (DELETE AFTER READING)
## Question (the more details, the better)

> - 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, we’ll 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.
## Question
30 changes: 11 additions & 19 deletions .github/ISSUE_TEMPLATE/samplerequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,23 @@
name: "\U0001F9EA Sample request"
about: Request a new sample from the community
title: ''
labels: ''
labels: type:sample-request
assignees: ''

---

> Please note that issues that do not follow this template will automatically be rejected.
>
> 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.
>
> _(DELETE THIS PARAGRAPH AFTER READING)_
Thank you for making a request! Use the sections below to submit a request ONLY for a new sample. If you have an issue or question about list formatting or its documentation, please submit it at https://aka.ms/spdev-issues

## Expected or Desired Sample
- Requests that do not follow the below template will automatically be closed
- All requests are welcome - the more the merrier!
- This repo is maintained by volunteers (not Microsoft). Please be courteous and patient. 🙂
- If you have multiple requests submit them separately so we can track resolution.
- Screenshots are always helpful (just paste any images right here in the request)
- We accept pull requests. If you know how to make it - go ahead!

> _Please explain what you'd like the sample to demonstrate.
>
> _(DELETE THIS PARAGRAPH AFTER READING)_
DELETE EVERYTHING ABOVE AFTER READING - THANKS!

## Guidelines for issue creator (DELETE AFTER READING)
## Sample Description (what should it do)

> - 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, we’ll 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.
## Are you Willing to Help?

0 comments on commit f3480eb

Please sign in to comment.