Labelling in GitHub

This article documents how we label issues and pull requests in the PowerShell-Docs repository. This article is designed to be a job aid for members of the PowerShell-Docs team. It's published here to provide process transparency for our public contributors.

Labels always have a name and a description that is prefixed with their type.

Area labels

Area labels identify the parts of PowerShell or the documentation that the issue relates to.

Label	Related Content
area-about	The about_* topic articles.
area-archive	The Microsoft.PowerShell.Archive module.
area-cim	The CimCmdlets module.
area-community	Community-facing projects, including the contributor's guide and monthly updates.
area-conceptual	Conceptual (non-reference) articles.
area-console	The console host
area-core	The Microsoft.PowerShell.Core module.
area-crescendo	The Crescendo module.
area-debugging	Debugging PowerShell.
area-diagnostics	The Microsoft.PowerShell.Diagnostics module.
area-dsc	PowerShell Desired State Configuration.
area-editorsvcs	The PowerShell editor services.
area-engine	The PowerShell engine.
area-error-handling	Error handling in PowerShell
area-experimental	PowerShell's experimental features
area-gallery	The PowerShell Gallery.
area-helpsystem	The Help services, including the pipeline and *-Help cmdlets.
area-host	The Microsoft.PowerShell.Host module.
area-ise	The PowerShell ISE.
area-jea	The Just Enough Administration feature.
area-language	The PowerShell syntax and keywords.
area-learn	The structured training content for PowerShell.
area-localaccounts	The Microsoft.PowerShell.LocalAccounts module.
area-localization	Localization problems or opportunities for the content.
area-management	The Microsoft.PowerShell.Management module.
area-native-cmds	Using native commands in PowerShell.
area-omi	Open Management Infrastructure & CDXML.
area-ops-issue	Building and rendering the content on the site.
area-other	Miscellaneous modules.
area-overview	The overview section in the conceptual content.
area-packagemanagement	The PackageManagement module.
area-parallelism	Content covering parallel processing, such as using ForEach-Object or PowerShell Jobs.
area-platyps	The PlatyPS module.
area-portability	Cross-platform compatibility.
area-powershellget	The PowerShellGet module.
area-providers	PowerShell providers.
area-psreadline	The PSReadline module.
area-release-notes	The PowerShell release notes.
area-remoting	The PowerShell remoting feature and cmdlets.
area-scriptanalyzer	The PSScriptAnalyzer module.
area-sdk-docs	The conceptual documentation for the PowerShell SDK.
area-sdk-ref	The .NET API reference documentation for the PowerShell SDK.
area-security	The Microsoft.PowerShell.Security module and security concepts in general.
area-setup	Installing and configuring PowerShell.
area-threadjob	The ThreadJob module.
area-utility	The Microsoft.PowerShell.Utility module.
area-versions	Issues with the versioning of the documentation.
area-vscode	The VS Code PowerShell extension.
area-wincompat	The Windows Compatibility feature.
area-wmf	The Windows Management Framework.
area-workflow	The Windows PowerShell Workflow feature.

Issue labels

Issue labels distinguish issues by purpose.

Label	Issue Category
issue-doc-bug	Errors or ambiguities in the content
issue-doc-idea	Requests for new content
issue-kudos	Praise, positive feedback, or thanks rather than work items
issue-product-feedback	Feedback or problems with the product itself
issue-question	Support questions

Priority labels

Priority labels rank which work items need to be worked on before others. These labels are only used when needed to manage large sets of work items.

Label	Priority Level
Pri0	Highest
Pri1	High
Pri2	Medium
Pri3	Low

Project Labels

Project labels indicate what ongoing GitHub Project a work item is related to. These labels are used for automatically adding work items to a project on creation.

Label	Project
project-quality	The quality improvement project

Quality labels

Quality labels categorize work items for the quality improvement effort.

Label	Improvement
quality-aliases	Ensure cmdlet aliases are documented
quality-format-code-samples	Ensure proper casing, line length, and other formatting in code samples
quality-format-command-syntax	Ensure proper casing and formatting for command syntax
quality-link-references	Ensure links in conceptual docs are defined as numbered references
quality-markdownlint	Ensure content follows markdownlint rules
quality-spelling	Ensure proper casing and spelling for words

Status labels

Status labels indicate why a work item was closed or shouldn't be merged. Issues are only given status labels when they're closed without a related PR.

Label	Status
resolution-answered	Closed by existing documentation
resolution-duplicate	Closed as duplicate issue
resolution-external	Closed by customer or outside resource
resolution-no-repro	Unable to reproduce the reported issue
resolution-refer-to-support	Closed and referred to community or product support
resolution-wont-fix	Closed as won't fix

Tag labels

Tag labels add independent context for work items.

Label	Purpose
in-progress	Someone is actively working on the item
go-live	The work item is related to a specific release
doc-a-thon	The work item is related to a doc-a-thon
up-for-grabs	Any contributor may volunteer to resolve the work item
hacktoberfest-accepted	The PR is accepted for inclusion in #hacktoberfest
hacktoberfest-candidate	The PR is a candidate for inclusion in #hacktoberfest
needs-triage	The issue needs to be triaged by the team before it is ready to be worked
code-of-conduct	Closed for spam, trolling, or code of conduct violations
do-not-merge	The PR isn't meant to be merged

Waiting labels

Waiting labels indicate that a work item can't be resolved until an external condition is met.

Label	Waiting For
hold-for-pr	Upstream PR to be merged
hold-for-release	Upstream product to release
needs-investigation	Waiting for team member to verify or research
needs-more-info	Additional details or clarification from work item author
needs-response	Response from work item author
review-shiproom	Shiproom discussion with the PowerShell team