-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(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
- Loading branch information
1 parent
8f5dce6
commit 389a9b1
Showing
5 changed files
with
191 additions
and
191 deletions.
There are no files selected for viewing
184 changes: 92 additions & 92 deletions
184
.github/ISSUE_TEMPLATE/02-bug.yml → .github/ISSUE_TEMPLATE/00-bug.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,92 +1,92 @@ | ||
| name: "🐛 Report Documentation issue" | ||
| description: >- | ||
| Report an issue with current documentation. | ||
| labels: | ||
| - doc-bug | ||
| - needs-triage | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Use this template to report issues with documentation. This can include typos, technical and factual errors, grammar, spelling, formatting, presentation, etc. | ||
| Support questions should be posted to community support forums. See the [Community support](https://learn.microsoft.com/powershell/scripting/community/community-support) page. | ||
| - type: checkboxes | ||
| id: prerequisites | ||
| attributes: | ||
| label: Prerequisites | ||
| description: >- | ||
| These steps are required. After you've completed each step, check the box for it before | ||
| moving on. | ||
| options: | ||
| - label: >- | ||
| **Existing Issue:** Search the existing issues for this repository. If there is an issue | ||
| that fits your needs do not file a new one. Subscribe, react, or comment on that issue | ||
| instead. | ||
| required: true | ||
| - label: >- | ||
| **Descriptive Title:** Write the title for this issue as a short synopsis. If possible, | ||
| provide context. For example, "Typo in `Get-Foo` cmdlet" instead of "Typo." | ||
| required: true | ||
| - label: >- | ||
| **Verify Version:** If there is a mismatch between documentation and the module on your | ||
| system, ensure that the version you are using is the same as the documentation. Check | ||
| this box if they match or the issue you are reporting is not version specific. | ||
| required: true | ||
| - type: dropdown | ||
| id: module | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: Module | ||
| description: >- | ||
| Select the module or modules the problem affects. | ||
| multiple: true | ||
| options: | ||
| - Crescendo | ||
| - PlatyPS | ||
| - PSScriptAnalyzer | ||
| - SecretManagement | ||
| - SecretStore | ||
| - type: textarea | ||
| id: link_list | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: Links | ||
| description: >- | ||
| Provide a list of links to the documentation page(s) that show the problem you are | ||
| reporting. Use the markdown list syntax for each item. If you are linking to the source for the | ||
| document, please use the permalink to the lines that show the problem. If you are linking to | ||
| the live page for the document, please ensure each link is to the nearest header anchor to | ||
| the problem instead of the page itself. | ||
| placeholder: | | ||
| - https://github.com/MicrosoftDocs/PowerShell-Docs-Modules/blob/2d7879a4c26b4a9d3aac906d18847f27ae509cdd/reference/docs-conceptual/Crescendo/overview.md?plain=1#L31-L38 | ||
| - https://learn.microsoft.com/powershell/utility-modules/crescendo/overview?view=ps-modules#crescendo-specific-terminology | ||
| - type: textarea | ||
| id: summary | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: Summary | ||
| description: >- | ||
| Write a clear and concise description of the problem. | ||
| - type: textarea | ||
| id: details | ||
| validations: | ||
| required: false | ||
| attributes: | ||
| label: Details | ||
| description: >- | ||
| If possible, please provide extended details that will add context and help the team update | ||
| the documentation. Additional details may not be useful for typos, grammar, formatting, etc. | ||
| For technical or factual errors, please include code snippets and output to show how the | ||
| documentation is incorrect. | ||
| - type: textarea | ||
| id: suggestion | ||
| validations: | ||
| required: false | ||
| attributes: | ||
| label: Suggested Fix | ||
| description: >- | ||
| If you have an idea for how to fix the problem you're identifying, include it here. | ||
| name: "🐛 Report a documentation issue" | ||
| description: >- | ||
| Report an issue with current documentation. | ||
| labels: | ||
| - doc-bug | ||
| - needs-triage | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Use this template to report issues with documentation. This can include typos, technical and factual errors, grammar, spelling, formatting, presentation, etc. | ||
| Support questions should be posted to community support forums. See the [Community support](https://learn.microsoft.com/powershell/scripting/community/community-support) page. | ||
| - type: checkboxes | ||
| id: prerequisites | ||
| attributes: | ||
| label: Prerequisites | ||
| description: >- | ||
| These steps are required. After you've completed each step, check the box for it before | ||
| moving on. | ||
| options: | ||
| - label: >- | ||
| **Existing Issue:** Search the existing issues for this repository. If there is an issue | ||
| that fits your needs do not file a new one. Subscribe, react, or comment on that issue | ||
| instead. | ||
| required: true | ||
| - label: >- | ||
| **Descriptive Title:** Write the title for this issue as a short synopsis. If possible, | ||
| provide context. For example, "Typo in `Get-Foo` cmdlet" instead of "Typo." | ||
| required: true | ||
| - label: >- | ||
| **Verify Version:** If there is a mismatch between documentation and the module on your | ||
| system, ensure that the version you are using is the same as the documentation. Check | ||
| this box if they match or the issue you are reporting is not version specific. | ||
| required: true | ||
| - type: dropdown | ||
| id: module | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: Module | ||
| description: >- | ||
| Select the module or modules the problem affects. | ||
| multiple: true | ||
| options: | ||
| - Crescendo | ||
| - PlatyPS | ||
| - PSScriptAnalyzer | ||
| - SecretManagement | ||
| - SecretStore | ||
| - type: textarea | ||
| id: link_list | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: Links | ||
| description: >- | ||
| Provide a list of links to the documentation page(s) that show the problem you are | ||
| reporting. Use the markdown list syntax for each item. If you are linking to the source for the | ||
| document, please use the permalink to the lines that show the problem. If you are linking to | ||
| the live page for the document, please ensure each link is to the nearest header anchor to | ||
| the problem instead of the page itself. | ||
| placeholder: | | ||
| - https://github.com/MicrosoftDocs/PowerShell-Docs-Modules/blob/2d7879a4c26b4a9d3aac906d18847f27ae509cdd/reference/docs-conceptual/Crescendo/overview.md?plain=1#L31-L38 | ||
| - https://learn.microsoft.com/powershell/utility-modules/crescendo/overview?view=ps-modules#crescendo-specific-terminology | ||
| - type: textarea | ||
| id: summary | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: Summary | ||
| description: >- | ||
| Write a clear and concise description of the problem. | ||
| - type: textarea | ||
| id: details | ||
| validations: | ||
| required: false | ||
| attributes: | ||
| label: Details | ||
| description: >- | ||
| If possible, please provide extended details that will add context and help the team update | ||
| the documentation. Additional details may not be useful for typos, grammar, formatting, etc. | ||
| For technical or factual errors, please include code snippets and output to show how the | ||
| documentation is incorrect. | ||
| - type: textarea | ||
| id: suggestion | ||
| validations: | ||
| required: false | ||
| attributes: | ||
| label: Suggested Fix | ||
| description: >- | ||
| If you have an idea for how to fix the problem you're identifying, include it here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
170 changes: 85 additions & 85 deletions
170
.github/ISSUE_TEMPLATE/00-quality.yml → .github/ISSUE_TEMPLATE/02-quality.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,85 +1,85 @@ | ||
| name: "🛠️ Quality Contribution" | ||
| description: >- | ||
| File a new issue to tackle quality improvement opportunities | ||
| title: "Quality: " | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| This issue template is for the [PowerShell Docs Quality Contributions project][a1]. | ||
| For more more info, see [Contributing quality improvements][a2] in our Contributor's Guide. | ||
| [a1]: https://github.com/orgs/MicrosoftDocs/projects/15 | ||
| [a2]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements | ||
| - type: checkboxes | ||
| id: prerequisites | ||
| attributes: | ||
| label: Prerequisites | ||
| description: >- | ||
| These steps are required. After you've completed each step, check the box for it before | ||
| moving on. | ||
| options: | ||
| - label: | | ||
| **Existing Issue:** | ||
| Search the existing [quality issues][b1] for this repository. If there's an issue that | ||
| covers the quality area and articles you want to improve, pick a different quality area | ||
| or article set. Don't file a new issue for the same work. Subscribe, react, or comment | ||
| on that issue instead. | ||
| [b1]: https://github.com/orgs/MicrosoftDocs/projects/15/views/3?filterQuery=repo%3A%22MicrosoftDocs%2FPowerShell-Docs-Modules%22+is%3Aissue | ||
| required: true | ||
| - label: | | ||
| **Descriptive Title:** | ||
| Write the title for this issue as a short synopsis. If possible, provide context. For | ||
| example, "Quality: Command Syntax in Foo" instead of "Quality: Foo" | ||
| required: true | ||
| - type: dropdown | ||
| id: QualityArea | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: Quality Areas | ||
| description: | | ||
| Select one or more quality areas to improve on with your contribution. | ||
| For more information, see the relevant section in the meta issue: | ||
| - [Aliases][c1]: Ensure cmdlet aliases are documented | ||
| - [Formatting code samples][c2]: Ensure proper casing, line length, etc in code samples | ||
| - [Formatting command syntax][c3]: Ensure proper casing and formatting for command syntax, including cmdlets, types, etc. | ||
| - [Link References][c4]: Ensure links in conceptual docs are defined as numbered references | ||
| - [Markdown linting][c5]: Ensure content follows markdownlint rules | ||
| - [Spelling][c6]: Ensure proper casing and spelling for words | ||
| [c1]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#aliases | ||
| [c2]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#formatting-code-samples | ||
| [c3]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#formatting-command-syntax | ||
| [c4]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#link-references | ||
| [c5]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#markdown-linting | ||
| [c6]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#spelling | ||
| multiple: true | ||
| options: | ||
| - Aliases | ||
| - Formatting code samples | ||
| - Formatting command syntax | ||
| - Link References | ||
| - Markdown linting | ||
| - Spelling | ||
| - type: textarea | ||
| id: ArticleList | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: Article List | ||
| description: >- | ||
| Specify the articles you are committing to work on, one per line. You can specify each entry | ||
| as a path, the article's title, or the link to the article on Learn. If you specify an | ||
| article by path for a reference article, such as a cmdlet or about topic, specify the | ||
| version segment as `*.*`. | ||
| placeholder: | | ||
| - reference/*.*/Microsoft.PowerShell.Core/Add-History.md | ||
| - Add-History | ||
| - https://learn.microsoft.com/powershell/module/microsoft.powershell.core/add-history | ||
| name: "🦾 Commit to a Quality Contribution" | ||
| description: >- | ||
| File an issue to take part in the PowerShell Docs Quality Contributions project. | ||
| title: "Quality: " | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| This issue template is for the [PowerShell Docs Quality Contributions project][a1]. | ||
| For more more info, see [Contributing quality improvements][a2] in our Contributor's Guide. | ||
| [a1]: https://github.com/orgs/MicrosoftDocs/projects/15 | ||
| [a2]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements | ||
| - type: checkboxes | ||
| id: prerequisites | ||
| attributes: | ||
| label: Prerequisites | ||
| description: >- | ||
| These steps are required. After you've completed each step, check the box for it before | ||
| moving on. | ||
| options: | ||
| - label: | | ||
| **Existing Issue:** | ||
| Search the existing [quality issues][b1] for this repository. If there's an issue that | ||
| covers the quality area and articles you want to improve, pick a different quality area | ||
| or article set. Don't file a new issue for the same work. Subscribe, react, or comment | ||
| on that issue instead. | ||
| [b1]: https://github.com/orgs/MicrosoftDocs/projects/15/views/3?filterQuery=repo%3A%22MicrosoftDocs%2FPowerShell-Docs-Modules%22+is%3Aissue | ||
| required: true | ||
| - label: | | ||
| **Descriptive Title:** | ||
| Write the title for this issue as a short synopsis. If possible, provide context. For | ||
| example, "Quality: Command Syntax in Foo" instead of "Quality: Foo" | ||
| required: true | ||
| - type: dropdown | ||
| id: QualityArea | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: Quality Areas | ||
| description: | | ||
| Select one or more quality areas to improve on with your contribution. | ||
| For more information, see the relevant section in the meta issue: | ||
| - [Aliases][c1]: Ensure cmdlet aliases are documented | ||
| - [Formatting code samples][c2]: Ensure proper casing, line length, etc in code samples | ||
| - [Formatting command syntax][c3]: Ensure proper casing and formatting for command syntax, including cmdlets, types, etc. | ||
| - [Link References][c4]: Ensure links in conceptual docs are defined as numbered references | ||
| - [Markdown linting][c5]: Ensure content follows markdownlint rules | ||
| - [Spelling][c6]: Ensure proper casing and spelling for words | ||
| [c1]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#aliases | ||
| [c2]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#formatting-code-samples | ||
| [c3]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#formatting-command-syntax | ||
| [c4]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#link-references | ||
| [c5]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#markdown-linting | ||
| [c6]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#spelling | ||
| multiple: true | ||
| options: | ||
| - Aliases | ||
| - Formatting code samples | ||
| - Formatting command syntax | ||
| - Link References | ||
| - Markdown linting | ||
| - Spelling | ||
| - type: textarea | ||
| id: ArticleList | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: Article List | ||
| description: >- | ||
| Specify the articles you are committing to work on, one per line. You can specify each entry | ||
| as a path, the article's title, or the link to the article on Learn. If you specify an | ||
| article by path for a reference article, such as a cmdlet or about topic, specify the | ||
| version segment as `*.*`. | ||
| placeholder: | | ||
| - reference/*.*/Microsoft.PowerShell.Core/Add-History.md | ||
| - Add-History | ||
| - https://learn.microsoft.com/powershell/module/microsoft.powershell.core/add-history |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.