Skip to content

Commit a67128d

Browse files
andrewconnellandrewconnell
committed
update & add issue templates
1 parent 8b4d76a commit a67128d

File tree

5 files changed

+141
-41
lines changed

5 files changed

+141
-41
lines changed

‎.github/ISSUE_TEMPLATE.md

Lines changed: 18 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,29 @@
1-
> Thank you for reporting an issue or 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.
2-
>
3-
> _(DELETE THIS PARAGRAPH AFTER READING)_
4-
>
5-
6-
#### Category
1+
## Category
72
- [ ] Question
83
- [ ] Typo
9-
- [ ] Bug
104
- [ ] Additional article idea
11-
- [x] Example checked item (*delete this line*)
12-
13-
> For the above list, an empty checkbox is [ ] as in <kbd>[</kbd><kbd>SPACE</kbd><kbd>]</kbd>. A checked checkbox is [x] with no space between the brackets. Use the `PREVIEW` tab at the top right to preview the rendering before submitting your issue.
14-
>
15-
> If you are planning to share a new feature request (enhancement / suggestion), please use SP Dev UserVoice at https://aka.ms/sp-dev-uservoice. (DELETE THIS PARAGRAPH AFTER READING)
16-
>
17-
> _(DELETE THIS PARAGRAPH AFTER READING)_
18-
>
19-
20-
#### Expected or Desired Behavior
21-
22-
> If you are reporting a bug, please describe the expected behavior. If you are suggesting an enhancement please describe thoroughly the enhancement, how it can be achieved, and expected benefit.
23-
>
24-
> _(DELETE THIS PARAGRAPH AFTER READING)_
25-
>
5+
- [x] Checked items have no spaces between the <kbd>[</kbd><kbd>]</kbd> (*delete this line*)
266

27-
#### Observed Behavior
7+
## Question
288

29-
> If you are reporting a bug, please describe the behavior you expected to occur when performing the action. If you are making a suggestion, you can delete this section.
30-
>
31-
> _(DELETE THIS PARAGRAPH AFTER READING)_
32-
>
9+
> **DELETE THIS LINE BEFORE SUBMITTING** - If you are reporting a bug, please describe the expected behavior. If you are suggesting an enhancement please describe thoroughly the enhancement, how it can be achieved, and the expected benefit.
3310
34-
#### Steps to Reproduce
11+
## Environment details (if applicable)
3512

36-
> If you are reporting a bug please describe the steps to reproduce the bug in sufficient detail to allow testing. Only way to fix things properly, is to have sufficient details to reproduce it. If you are making a suggestion, you can delete this section.
37-
>
38-
> _(DELETE THIS PARAGRAPH AFTER READING)_
39-
>
13+
> **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*). If this section is not relevant to your issue, please delete it.
4014
41-
#### Submission Guidelines
15+
- OS: [e.g. Windows 10, MacOS 10.15.x]
16+
- Framework: [e.g. .NET Framework v3.x, .NET Core v3.x, Node.js v6/v8/v10/v12]
17+
- Browser(s): [e.g. Chrome v79, Safari v22, FireFox v31, IE v11, Edge, Chromium Edge v79]
18+
- Tooling: [e.g. VS Code, SPFx v1.10.0, Visual Studio 2019]
19+
20+
## Submission guidelines (delete this section before submitting)
4221

43-
> - All suggestions or bugs are welcome, please let us know what's on your mind.
44-
> - If you are reporting an issue around any of the documents or articles, please ensure that you have clear > reference on the specific file or URL, which should be fixed.
45-
> - 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://network.office.com/t5/SharePoint-Developer/bd-p/SharePointDev] at Office Network.
22+
> - All suggestions or bugs are welcome!
23+
> - Follow our guidance on [How To Create Good Issues](https://github.com/sharepoint/playground-repo/wiki/How-to-Create-Good-Issues).
24+
> - If you are reporting an issue around any of the documents or articles, please ensure that you have referenced the specific file or URL of the related document.
25+
> - If you have technical questions about the framework, we monitor the tags #spfx, #spfx-webparts, and #spfx-tooling on [SharePoint StackExchange](http://sharepoint.stackexchange.com).
4626
> - Remember to include sufficient details and context.
47-
> - If you have multiple suggestions or bugs please submit them in separate bugs so we can track resolution.
48-
>
49-
> _(DELETE THIS PARAGRAPH AFTER READING)_
50-
>
27+
> - If you have multiple questions, suggestions, or bugs, please submit them in separate issues.
5128
52-
Thanks for your contribution! Sharing is caring.
29+
*Thanks for your contribution! Sharing is caring.*

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
name: Bug / error report
3+
about: Submit a bug or error report.
4+
title: ''
5+
labels: 'Needs: Triage'
6+
assignees: ''
7+
8+
---
9+
10+
## Category
11+
12+
- [x] Bug
13+
14+
## Describe the bug
15+
16+
> **DELETE THIS LINE BEFORE SUBMITTING** - Provide a clear & concise description of what the bug is. Please follow our guidance on [How To Create Good Issues](https://github.com/sharepoint/playground-repo/wiki/How-to-Create-Good-Issues) which explains how to apply formatting, adding references & resources, screenshots, etc.
17+
18+
## Steps to reproduce
19+
20+
> **DELETE THIS LINE BEFORE SUBMITTING** - Provide steps to reproduce the behavior:
21+
22+
1. Go to '...'
23+
1. Click on '....'
24+
1. Scroll down to '....'
25+
1. See error
26+
27+
## Expected behavior
28+
29+
> **DELETE THIS LINE BEFORE SUBMITTING** - Provide clear & concise description of what you expected to happen.
30+
31+
## Developer environment
32+
33+
> **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*).
34+
35+
- OS: [e.g. Windows 10, MacOS 10.15.x]
36+
- Framework: [e.g. .NET Framework v3.x, .NET Core v3.x, Node.js v6/v8/v10/v12]
37+
- Browser(s): [e.g. Chrome v79, Safari v22, FireFox v31, IE v11, Edge, Chromium Edge v79]
38+
- Tooling: [e.g. VS Code, SPFx v1.10.0, Visual Studio 2019]
39+
40+
### Additional context
41+
42+
> **DELETE THIS LINE BEFORE SUBMITTING** - Provide any other context about the problem.
43+
44+
*Thanks for your contribution! Sharing is caring.*

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: SharePoint Developer Documentation
4+
url: https://docs.microsoft.com/sharepoint/dev
5+
about: All developer documentatino for SharePoint can be found here.
6+
- name: SharePoint TechCommunity
7+
url: https://techcommunity.microsoft.com/t5/SharePoint/ct-p/SharePoint
8+
about: Please submit non-developer questions/reports to the SharePoint TechCommunity site. This includes anything related to administrator, end-user, or user experience capabilities, questions, and errors.
9+
- name: SharePoint Dev UserVoice
10+
url: https://aka.ms/sp-dev-uservoice
11+
about: Please submit feature requests and suggestions here.

‎.github/ISSUE_TEMPLATE/custom.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Question or generic issue (not a bug or feature request)
3+
about: Do you have a question that isn't a bug or feature request, or something else that doesn't fit one of our provided tempaltes? Select this option.
4+
title: ''
5+
labels: 'Needs: Triage'
6+
assignees: ''
7+
8+
---
9+
10+
## Category
11+
- [ ] Question
12+
- [ ] Typo
13+
- [ ] Additional article idea
14+
- [x] Checked items have no spaces between the <kbd>[</kbd><kbd>]</kbd> (*delete this line*)
15+
16+
## Question
17+
18+
> **DELETE THIS LINE BEFORE SUBMITTING** - If you are reporting a bug, please describe the expected behavior. If you are suggesting an enhancement please describe thoroughly the enhancement, how it can be achieved, and the expected benefit.
19+
>
20+
> _(DELETE THIS PARAGRAPH BEFORE SUBMITTING)_
21+
22+
## Environment details
23+
> **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*).
24+
25+
- OS: [e.g. Windows 10, MacOS 10.15.x]
26+
- Framework: [e.g. .NET Framework v3.x, .NET Core v3.x, Node.js v6/v8/v10/v12]
27+
- Browser(s): [e.g. Chrome v79, Safari v22, FireFox v31, IE v11, Edge, Chromium Edge v79]
28+
- Tooling: [e.g. VS Code, SPFx v1.10.0, Visual Studio 2019]
29+
30+
## Submission guidelines (delete this section before submitting)
31+
32+
> - All suggestions or bugs are welcome!
33+
> - Follow our guidance on [How To Create Good Issues](https://github.com/sharepoint/playground-repo/wiki/How-to-Create-Good-Issues).
34+
> - If you are reporting an issue around any of the documents or articles, please ensure that you have referenced the specific file or URL of the related document.
35+
> - If you have technical questions about the framework, we monitor the tags #spfx, #spfx-webparts, and #spfx-tooling on [SharePoint StackExchange](http://sharepoint.stackexchange.com).
36+
> - Remember to include sufficient details and context.
37+
> - If you have multiple questions, suggestions, or bugs, please submit them in separate issues.
38+
39+
*Thanks for your contribution! Sharing is caring.*

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea or feature request. Feature requests should be submitted to the SP Dev UserVoice site (linked below). Feature requests submitted as issues will be automatically closed.
4+
title: ''
5+
labels: type:uservoice-request
6+
assignees: ''
7+
8+
---
9+
10+
## Category
11+
- [x] Feature request
12+
13+
> Microsoft SharePoint engineering & planning base new feature requests on submissions to UserVoice. Please submit your feature request to [SP Dev UserVoice](https://aka.ms/sp-dev-uservoice) at https://aka.ms/sp-dev-uservoice.
14+
>
15+
> If you submit a feature request using this form, your issue will be **automatically labeled & closed**. Please feel free to create the issue here and use the link in your UserVoice submission.
16+
17+
## Is your feature request related to a problem?
18+
> **DELETE THIS LINE BEFORE SUBMITTING** - Provide clear & concise description of what the problem is.
19+
20+
## Describe the solution you'd like
21+
> **DELETE THIS LINE BEFORE SUBMITTING** - Provide a clear and concise description of what you want to happen.
22+
23+
## Describe alternatives you've considered
24+
> **DELETE THIS LINE BEFORE SUBMITTING** - Provide a clear and concise description of any alternative solutions or features you've considered.
25+
26+
## Additional context
27+
> **DELETE THIS LINE BEFORE SUBMITTING** - Provide any other context or screenshots about the feature request here.
28+
29+
*Thanks for your contribution! Sharing is caring.*

0 commit comments

Comments
 (0)