Skip to content

Commit 198dd77

Browse files
committed
Update issue & PR templates
- included message issues & PRs will be tagged & autoclosed as incomplete if they ignore the provided sections
1 parent 5733a98 commit 198dd77

File tree

5 files changed

+54
-39
lines changed

5 files changed

+54
-39
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,28 @@
77

88
## Question
99

10-
> **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.
10+
> **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.*
1111
1212
## Environment details (if applicable)
1313

14-
> **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.
14+
> **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.*
1515
16-
- **OS**: [e.g. Windows 10 | MacOS 10.15.x]
16+
- **Your Developer Environment**: [e.g. Windows 10 | MacOS 10.15.x]
1717
- **Target Environment**: [e.g. SharePoint Server 2016 | SharePoint Server 2019 | SharePoint Online]
1818
- **Framework**: [e.g. .NET Framework v3.x | .NET Core v3.x | Node.js v6/v8/v10/v12]
1919
- **Browser(s)**: [e.g. Chrome v79 | Safari v22 | FireFox v31 | IE v11 | Edge | Chromium Edge v79]
2020
- **Tooling**: [e.g. VS Code | SPFx v1.10.0 | Visual Studio 2019]
2121
- **Additional details**: *The more context you can provide, the easier it is (and therefore quicker) to help.*
2222

23-
## Submission guidelines (delete this section before submitting)
23+
## Submission guidelines
2424

25-
> - All suggestions or bugs are welcome!
25+
> - **!!IMPORTANT!!** - All submissions must complete the baseline sections included in this template. Ignoring or deleting this template may result in closing the issue with the label **type:incomplete-submission**.
2626
> - Follow our guidance on [How To Create Good Issues](https://github.com/sharepoint/playground-repo/wiki/How-to-Create-Good-Issues).
2727
> - 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.
2828
> - 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).
2929
> - Remember to include sufficient details and context.
3030
> - If you have multiple questions, suggestions, or bugs, please submit them in separate issues.
31-
32-
*Thanks for your contribution! Sharing is caring.*
31+
>
32+
> **DELETE THIS SECTION BEFORE SUBMITTING**
33+
>
34+
> *Thanks for your contribution! Sharing is caring.*

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ assignees: ''
3232

3333
> **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*).
3434
35-
- **OS**: [e.g. Windows 10 | MacOS 10.15.x]
35+
- **Your Developer Environment**: [e.g. Windows 10 | MacOS 10.15.x]
3636
- **Target Environment**: [e.g. SharePoint Server 2016 | SharePoint Server 2019 | SharePoint Online]
3737
- **Framework**: [e.g. .NET Framework v3.x | .NET Core v3.x | Node.js v6/v8/v10/v12]
3838
- **Browser(s)**: [e.g. Chrome v79 | Safari v22 | FireFox v31 | IE v11 | Edge | Chromium Edge v79]
@@ -44,3 +44,16 @@ assignees: ''
4444
> **DELETE THIS LINE BEFORE SUBMITTING** - Provide any other context about the problem.
4545
4646
*Thanks for your contribution! Sharing is caring.*
47+
48+
## Submission guidelines
49+
50+
> - **!!IMPORTANT!!** - All submissions must complete the baseline sections included in this template. Ignoring or deleting this template may result in closing the issue with the label **type:incomplete-submission**.
51+
> - Follow our guidance on [How To Create Good Issues](https://github.com/sharepoint/playground-repo/wiki/How-to-Create-Good-Issues).
52+
> - 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.
53+
> - 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).
54+
> - Remember to include sufficient details and context.
55+
> - If you have multiple questions, suggestions, or bugs, please submit them in separate issues.
56+
>
57+
> **DELETE THIS SECTION BEFORE SUBMITTING**
58+
>
59+
> *Thanks for your contribution! Sharing is caring.*

.github/ISSUE_TEMPLATE/custom.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,28 +16,28 @@ assignees: ''
1616

1717
## Question
1818

19-
> **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.
20-
>
21-
> _(DELETE THIS PARAGRAPH BEFORE SUBMITTING)_
19+
> **DELETE THIS LINE BEFORE SUBMITTING** | *If you are reporting a bug, please use our [bug issue template](new?assignees=&labels=Needs%3A+Triage&template=bug_report.md&title=). If you are suggesting an enhancement please describe thoroughly the enhancement, how it can be achieved, and the expected benefit.*
2220
2321
## Environment details (*development & target environment*)
2422

25-
> **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*).
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).*
2624
27-
- **OS**: [e.g. Windows 10 | MacOS 10.15.x]
25+
- **Your Developer Environment**: [e.g. Windows 10 | MacOS 10.15.x]
2826
- **Target Environment**: [e.g. SharePoint Server 2016 | SharePoint Server 2019 | SharePoint Online]
2927
- **Framework**: [e.g. .NET Framework v3.x | .NET Core v3.x | Node.js v6/v8/v10/v12]
3028
- **Browser(s)**: [e.g. Chrome v79 | Safari v22 | FireFox v31 | IE v11 | Edge | Chromium Edge v79]
3129
- **Tooling**: [e.g. VS Code | SPFx v1.10.0 | Visual Studio 2019]
3230
- **Additional details**: *The more context you can provide, the easier it is (and therefore quicker) to help.*
3331

34-
## Submission guidelines (delete this section before submitting)
32+
## Submission guidelines
3533

36-
> - All suggestions or bugs are welcome!
34+
> - **!!IMPORTANT!!** - All submissions must complete the baseline sections included in this template. Ignoring or deleting this template may result in closing the issue with the label **type:incomplete-submission**.
3735
> - Follow our guidance on [How To Create Good Issues](https://github.com/sharepoint/playground-repo/wiki/How-to-Create-Good-Issues).
3836
> - 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.
3937
> - 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).
4038
> - Remember to include sufficient details and context.
4139
> - If you have multiple questions, suggestions, or bugs, please submit them in separate issues.
42-
43-
*Thanks for your contribution! Sharing is caring.*
40+
>
41+
> **DELETE THIS SECTION BEFORE SUBMITTING**
42+
>
43+
> *Thanks for your contribution! Sharing is caring.*

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,19 @@ assignees: ''
1616
> 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.
1717
1818
## Is your feature request related to a problem?
19-
> **DELETE THIS LINE BEFORE SUBMITTING** - Provide clear & concise description of what the problem is.
19+
20+
> **DELETE THIS LINE BEFORE SUBMITTING** | Provide clear & concise description of what the problem is.
2021
2122
## Describe the solution you'd like
22-
> **DELETE THIS LINE BEFORE SUBMITTING** - Provide a clear and concise description of what you want to happen.
23+
24+
> **DELETE THIS LINE BEFORE SUBMITTING** | Provide a clear and concise description of what you want to happen.
2325
2426
## Describe alternatives you've considered
25-
> **DELETE THIS LINE BEFORE SUBMITTING** - Provide a clear and concise description of any alternative solutions or features you've considered.
27+
28+
> **DELETE THIS LINE BEFORE SUBMITTING** | Provide a clear and concise description of any alternative solutions or features you've considered.
2629
2730
## Additional context
28-
> **DELETE THIS LINE BEFORE SUBMITTING** - Provide any other context or screenshots about the feature request here.
31+
32+
> **DELETE THIS LINE BEFORE SUBMITTING** | Provide any other context or screenshots about the feature request here.
2933
3034
*Thanks for your contribution! Sharing is caring.*

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,27 @@
1-
#### Category
1+
## Category
2+
23
- [ ] Content fix
34
- [ ] New article
45
- [x] Example checked item (*delete this line*)
56

6-
> 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.
7-
>
8-
> _(DELETE THIS PARAGRAPH AFTER READING)_
7+
> **DELETE THIS LINE BEFORE SUBMITTING** | *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.*
8+
9+
## Related issues
910

10-
#### Related issues:
1111
- fixes #issuenumber
1212
- partially #issuenumber
1313
- mentioned in #issuenumber
1414

15-
> If this fixes (aka: closes) or references an issue, please reference it here. This helps maintaining the issue list as it will (1) link the PR to the issue & (2) automatically close the issue when this PR is merged in.
16-
>
17-
> _(DELETE THIS PARAGRAPH AFTER READING)_
15+
> **DELETE THIS LINE BEFORE SUBMITTING** | *If this fixes (aka: closes) or references an issue, please reference it here. This helps maintaining the issue list as it will (1) link the PR to the issue & (2) automatically close the issue when this PR is merged in.*
1816
19-
#### What's in this Pull Request?
17+
## What's in this Pull Request?
2018

21-
> Please describe the changes in this PR. Sample description or details around bugs which are being fixed.
22-
>
23-
> _(DELETE THIS PARAGRAPH AFTER READING)_
19+
> **DELETE THIS LINE BEFORE SUBMITTING** | *Please describe the changes in this PR. Sample description or details around bugs which are being fixed.*
2420
25-
#### Guidance
21+
## Submission guidelines
2622

27-
> *Please update this PR information accordingly. We'll use this as part of our release notes in monthly communications.*
28-
>
29-
> *Please target your PR to 'master' branch. Released documents are in `live` branch.*
30-
>
31-
> _(DELETE THIS PARAGRAPH AFTER READING)_
23+
> - **!!IMPORTANT!!** - All submissions must complete the baseline sections included in this template. Ignoring or deleting this template may result in closing the issue with the label **type:incomplete-submission**.
24+
> - Follow our guidance on [How To Create Good Pull Requests](https://github.com/SharePoint/sp-dev-docs/wiki/How-to-Create-Good-Pull-Requests).
25+
> - Target the `master` branch of this repo. Released documents are in `live` branch.
26+
>
27+
> **DELETE THIS SECTION BEFORE SUBMITTING**

0 commit comments

Comments
 (0)