Skip to content

Commit 389a9b1

Browse files
(AB#37677) Reorganize and rename issue templates (#9443) (#115)
Prior to this change, distinguishing between issue templates and links could be a little difficult. This change: - Reorders the issue templates so filing a bug is the first option, then suggesting an improvement, committing to a quality contribution, and finally reporting a product change - Updates the issue template titles to use imperative language with a call to action and links in the issue picker to be questions - Updates the Quality Contributions project links to point to the updated templates
1 parent 8f5dce6 commit 389a9b1

File tree

5 files changed

+191
-191
lines changed

5 files changed

+191
-191
lines changed
Lines changed: 92 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -1,92 +1,92 @@
1-
name: "🐛 Report Documentation issue"
2-
description: >-
3-
Report an issue with current documentation.
4-
labels:
5-
- doc-bug
6-
- needs-triage
7-
body:
8-
- type: markdown
9-
attributes:
10-
value: |
11-
Use this template to report issues with documentation. This can include typos, technical and factual errors, grammar, spelling, formatting, presentation, etc.
12-
13-
Support questions should be posted to community support forums. See the [Community support](https://learn.microsoft.com/powershell/scripting/community/community-support) page.
14-
- type: checkboxes
15-
id: prerequisites
16-
attributes:
17-
label: Prerequisites
18-
description: >-
19-
These steps are required. After you've completed each step, check the box for it before
20-
moving on.
21-
options:
22-
- label: >-
23-
**Existing Issue:** Search the existing issues for this repository. If there is an issue
24-
that fits your needs do not file a new one. Subscribe, react, or comment on that issue
25-
instead.
26-
required: true
27-
- label: >-
28-
**Descriptive Title:** Write the title for this issue as a short synopsis. If possible,
29-
provide context. For example, "Typo in `Get-Foo` cmdlet" instead of "Typo."
30-
required: true
31-
- label: >-
32-
**Verify Version:** If there is a mismatch between documentation and the module on your
33-
system, ensure that the version you are using is the same as the documentation. Check
34-
this box if they match or the issue you are reporting is not version specific.
35-
required: true
36-
- type: dropdown
37-
id: module
38-
validations:
39-
required: true
40-
attributes:
41-
label: Module
42-
description: >-
43-
Select the module or modules the problem affects.
44-
multiple: true
45-
options:
46-
- Crescendo
47-
- PlatyPS
48-
- PSScriptAnalyzer
49-
- SecretManagement
50-
- SecretStore
51-
- type: textarea
52-
id: link_list
53-
validations:
54-
required: true
55-
attributes:
56-
label: Links
57-
description: >-
58-
Provide a list of links to the documentation page(s) that show the problem you are
59-
reporting. Use the markdown list syntax for each item. If you are linking to the source for the
60-
document, please use the permalink to the lines that show the problem. If you are linking to
61-
the live page for the document, please ensure each link is to the nearest header anchor to
62-
the problem instead of the page itself.
63-
placeholder: |
64-
- https://github.com/MicrosoftDocs/PowerShell-Docs-Modules/blob/2d7879a4c26b4a9d3aac906d18847f27ae509cdd/reference/docs-conceptual/Crescendo/overview.md?plain=1#L31-L38
65-
- https://learn.microsoft.com/powershell/utility-modules/crescendo/overview?view=ps-modules#crescendo-specific-terminology
66-
- type: textarea
67-
id: summary
68-
validations:
69-
required: true
70-
attributes:
71-
label: Summary
72-
description: >-
73-
Write a clear and concise description of the problem.
74-
- type: textarea
75-
id: details
76-
validations:
77-
required: false
78-
attributes:
79-
label: Details
80-
description: >-
81-
If possible, please provide extended details that will add context and help the team update
82-
the documentation. Additional details may not be useful for typos, grammar, formatting, etc.
83-
For technical or factual errors, please include code snippets and output to show how the
84-
documentation is incorrect.
85-
- type: textarea
86-
id: suggestion
87-
validations:
88-
required: false
89-
attributes:
90-
label: Suggested Fix
91-
description: >-
92-
If you have an idea for how to fix the problem you're identifying, include it here.
1+
name: "🐛 Report a documentation issue"
2+
description: >-
3+
Report an issue with current documentation.
4+
labels:
5+
- doc-bug
6+
- needs-triage
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Use this template to report issues with documentation. This can include typos, technical and factual errors, grammar, spelling, formatting, presentation, etc.
12+
13+
Support questions should be posted to community support forums. See the [Community support](https://learn.microsoft.com/powershell/scripting/community/community-support) page.
14+
- type: checkboxes
15+
id: prerequisites
16+
attributes:
17+
label: Prerequisites
18+
description: >-
19+
These steps are required. After you've completed each step, check the box for it before
20+
moving on.
21+
options:
22+
- label: >-
23+
**Existing Issue:** Search the existing issues for this repository. If there is an issue
24+
that fits your needs do not file a new one. Subscribe, react, or comment on that issue
25+
instead.
26+
required: true
27+
- label: >-
28+
**Descriptive Title:** Write the title for this issue as a short synopsis. If possible,
29+
provide context. For example, "Typo in `Get-Foo` cmdlet" instead of "Typo."
30+
required: true
31+
- label: >-
32+
**Verify Version:** If there is a mismatch between documentation and the module on your
33+
system, ensure that the version you are using is the same as the documentation. Check
34+
this box if they match or the issue you are reporting is not version specific.
35+
required: true
36+
- type: dropdown
37+
id: module
38+
validations:
39+
required: true
40+
attributes:
41+
label: Module
42+
description: >-
43+
Select the module or modules the problem affects.
44+
multiple: true
45+
options:
46+
- Crescendo
47+
- PlatyPS
48+
- PSScriptAnalyzer
49+
- SecretManagement
50+
- SecretStore
51+
- type: textarea
52+
id: link_list
53+
validations:
54+
required: true
55+
attributes:
56+
label: Links
57+
description: >-
58+
Provide a list of links to the documentation page(s) that show the problem you are
59+
reporting. Use the markdown list syntax for each item. If you are linking to the source for the
60+
document, please use the permalink to the lines that show the problem. If you are linking to
61+
the live page for the document, please ensure each link is to the nearest header anchor to
62+
the problem instead of the page itself.
63+
placeholder: |
64+
- https://github.com/MicrosoftDocs/PowerShell-Docs-Modules/blob/2d7879a4c26b4a9d3aac906d18847f27ae509cdd/reference/docs-conceptual/Crescendo/overview.md?plain=1#L31-L38
65+
- https://learn.microsoft.com/powershell/utility-modules/crescendo/overview?view=ps-modules#crescendo-specific-terminology
66+
- type: textarea
67+
id: summary
68+
validations:
69+
required: true
70+
attributes:
71+
label: Summary
72+
description: >-
73+
Write a clear and concise description of the problem.
74+
- type: textarea
75+
id: details
76+
validations:
77+
required: false
78+
attributes:
79+
label: Details
80+
description: >-
81+
If possible, please provide extended details that will add context and help the team update
82+
the documentation. Additional details may not be useful for typos, grammar, formatting, etc.
83+
For technical or factual errors, please include code snippets and output to show how the
84+
documentation is incorrect.
85+
- type: textarea
86+
id: suggestion
87+
validations:
88+
required: false
89+
attributes:
90+
label: Suggested Fix
91+
description: >-
92+
If you have an idea for how to fix the problem you're identifying, include it here.

.github/ISSUE_TEMPLATE/01-article.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: "💡 New Document Request/Idea"
1+
name: "💡 Suggest a new document or idea"
22
description: >-
33
Suggest a new document or major rewrite of an existing one.
44
labels:
Lines changed: 85 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,85 @@
1-
name: "🛠️ Quality Contribution"
2-
description: >-
3-
File a new issue to tackle quality improvement opportunities
4-
title: "Quality: "
5-
body:
6-
- type: markdown
7-
attributes:
8-
value: |
9-
This issue template is for the [PowerShell Docs Quality Contributions project][a1].
10-
11-
For more more info, see [Contributing quality improvements][a2] in our Contributor's Guide.
12-
13-
[a1]: https://github.com/orgs/MicrosoftDocs/projects/15
14-
[a2]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements
15-
- type: checkboxes
16-
id: prerequisites
17-
attributes:
18-
label: Prerequisites
19-
description: >-
20-
These steps are required. After you've completed each step, check the box for it before
21-
moving on.
22-
options:
23-
- label: |
24-
**Existing Issue:**
25-
26-
Search the existing [quality issues][b1] for this repository. If there's an issue that
27-
covers the quality area and articles you want to improve, pick a different quality area
28-
or article set. Don't file a new issue for the same work. Subscribe, react, or comment
29-
on that issue instead.
30-
31-
[b1]: https://github.com/orgs/MicrosoftDocs/projects/15/views/3?filterQuery=repo%3A%22MicrosoftDocs%2FPowerShell-Docs-Modules%22+is%3Aissue
32-
required: true
33-
- label: |
34-
**Descriptive Title:**
35-
36-
Write the title for this issue as a short synopsis. If possible, provide context. For
37-
example, "Quality: Command Syntax in Foo" instead of "Quality: Foo"
38-
required: true
39-
- type: dropdown
40-
id: QualityArea
41-
validations:
42-
required: true
43-
attributes:
44-
label: Quality Areas
45-
description: |
46-
Select one or more quality areas to improve on with your contribution.
47-
48-
For more information, see the relevant section in the meta issue:
49-
50-
- [Aliases][c1]: Ensure cmdlet aliases are documented
51-
- [Formatting code samples][c2]: Ensure proper casing, line length, etc in code samples
52-
- [Formatting command syntax][c3]: Ensure proper casing and formatting for command syntax, including cmdlets, types, etc.
53-
- [Link References][c4]: Ensure links in conceptual docs are defined as numbered references
54-
- [Markdown linting][c5]: Ensure content follows markdownlint rules
55-
- [Spelling][c6]: Ensure proper casing and spelling for words
56-
57-
[c1]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#aliases
58-
[c2]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#formatting-code-samples
59-
[c3]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#formatting-command-syntax
60-
[c4]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#link-references
61-
[c5]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#markdown-linting
62-
[c6]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#spelling
63-
multiple: true
64-
options:
65-
- Aliases
66-
- Formatting code samples
67-
- Formatting command syntax
68-
- Link References
69-
- Markdown linting
70-
- Spelling
71-
- type: textarea
72-
id: ArticleList
73-
validations:
74-
required: true
75-
attributes:
76-
label: Article List
77-
description: >-
78-
Specify the articles you are committing to work on, one per line. You can specify each entry
79-
as a path, the article's title, or the link to the article on Learn. If you specify an
80-
article by path for a reference article, such as a cmdlet or about topic, specify the
81-
version segment as `*.*`.
82-
placeholder: |
83-
- reference/*.*/Microsoft.PowerShell.Core/Add-History.md
84-
- Add-History
85-
- https://learn.microsoft.com/powershell/module/microsoft.powershell.core/add-history
1+
name: "🦾 Commit to a Quality Contribution"
2+
description: >-
3+
File an issue to take part in the PowerShell Docs Quality Contributions project.
4+
title: "Quality: "
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
This issue template is for the [PowerShell Docs Quality Contributions project][a1].
10+
11+
For more more info, see [Contributing quality improvements][a2] in our Contributor's Guide.
12+
13+
[a1]: https://github.com/orgs/MicrosoftDocs/projects/15
14+
[a2]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements
15+
- type: checkboxes
16+
id: prerequisites
17+
attributes:
18+
label: Prerequisites
19+
description: >-
20+
These steps are required. After you've completed each step, check the box for it before
21+
moving on.
22+
options:
23+
- label: |
24+
**Existing Issue:**
25+
26+
Search the existing [quality issues][b1] for this repository. If there's an issue that
27+
covers the quality area and articles you want to improve, pick a different quality area
28+
or article set. Don't file a new issue for the same work. Subscribe, react, or comment
29+
on that issue instead.
30+
31+
[b1]: https://github.com/orgs/MicrosoftDocs/projects/15/views/3?filterQuery=repo%3A%22MicrosoftDocs%2FPowerShell-Docs-Modules%22+is%3Aissue
32+
required: true
33+
- label: |
34+
**Descriptive Title:**
35+
36+
Write the title for this issue as a short synopsis. If possible, provide context. For
37+
example, "Quality: Command Syntax in Foo" instead of "Quality: Foo"
38+
required: true
39+
- type: dropdown
40+
id: QualityArea
41+
validations:
42+
required: true
43+
attributes:
44+
label: Quality Areas
45+
description: |
46+
Select one or more quality areas to improve on with your contribution.
47+
48+
For more information, see the relevant section in the meta issue:
49+
50+
- [Aliases][c1]: Ensure cmdlet aliases are documented
51+
- [Formatting code samples][c2]: Ensure proper casing, line length, etc in code samples
52+
- [Formatting command syntax][c3]: Ensure proper casing and formatting for command syntax, including cmdlets, types, etc.
53+
- [Link References][c4]: Ensure links in conceptual docs are defined as numbered references
54+
- [Markdown linting][c5]: Ensure content follows markdownlint rules
55+
- [Spelling][c6]: Ensure proper casing and spelling for words
56+
57+
[c1]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#aliases
58+
[c2]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#formatting-code-samples
59+
[c3]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#formatting-command-syntax
60+
[c4]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#link-references
61+
[c5]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#markdown-linting
62+
[c6]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#spelling
63+
multiple: true
64+
options:
65+
- Aliases
66+
- Formatting code samples
67+
- Formatting command syntax
68+
- Link References
69+
- Markdown linting
70+
- Spelling
71+
- type: textarea
72+
id: ArticleList
73+
validations:
74+
required: true
75+
attributes:
76+
label: Article List
77+
description: >-
78+
Specify the articles you are committing to work on, one per line. You can specify each entry
79+
as a path, the article's title, or the link to the article on Learn. If you specify an
80+
article by path for a reference article, such as a cmdlet or about topic, specify the
81+
version segment as `*.*`.
82+
placeholder: |
83+
- reference/*.*/Microsoft.PowerShell.Core/Add-History.md
84+
- Add-History
85+
- https://learn.microsoft.com/powershell/module/microsoft.powershell.core/add-history

.github/ISSUE_TEMPLATE/03-change.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: "🛠 Document Product Change"
1+
name: "🛠 Document a product change"
22
description: >-
33
Request documentation for a new or updated feature, cmdlet, parameter, or behavior.
44
labels:

0 commit comments

Comments
 (0)