2016-08-03 20:06:36 +02:00
# Issue Management
2016-07-11 18:42:22 +02:00
## Long-living issue labels
2016-08-13 03:19:12 +02:00
=======
## Issue and PR Labels
Issues are opened for many different reasons.
We use the following labels for issue classifications:
* `Issue-Bug` : the issue is reporting a bug
2017-06-06 17:56:26 +02:00
* `Issue-Code Cleanup` : the issue is for cleaning up the code with no impact on functionality
2016-08-13 03:19:12 +02:00
* `Issue-Discussion` : the issue may not have a clear classification yet.
2016-09-16 04:40:19 +02:00
The issue may generate an [RFC][ln-rfc] or may be reclassified as a bug or enhancement.
2016-08-25 19:43:20 +02:00
* `Issue-Enhancement` : the issue is more of a feature request than a bug.
2016-09-07 20:32:31 +02:00
* `Issue-Meta` : an issue used to track multiple issues.
2016-08-13 03:19:12 +02:00
* `Issue-Question` : ideally support can be provided via other mechanisms,
but sometimes folks to open an issue to get a question answered and we will use this label for such issues.
[ln-rfc]: https://github.com/PowerShell/PowerShell-RFC
When an issue is resolved, the following labels are used to describe the resolution:
2016-09-07 20:32:31 +02:00
* `Resolution-Answered` : the issue was an `Issue-Question` and was answered.
* `Resolution-By Design` : the issue is not considered a bug, the behavior is working as designed.
* `Resolution-Duplicate` : the issue is a duplicate - there must be a comment linking to another issue.
2016-08-18 20:20:24 +02:00
* `Resolution-External` : the issue cannot be address by this repo. Should be addressed externally.
2016-09-07 20:32:31 +02:00
* `Resolution-Fixed` : the issue has been fixed and should be referenced from a PR.
2016-08-13 03:19:12 +02:00
* `Resolution-Won't Fix` : the issue may be considered a bug or enhancement but won't be fixed.
If there is an inadequate explanation as to why the issue was closed,
anyone should feel free to reopen the issue.
2016-07-11 18:42:22 +02:00
### Feature areas
2016-09-07 20:32:31 +02:00
These labels describe what feature area of PowerShell that an issue affects:
2016-07-11 18:42:22 +02:00
2016-07-22 17:50:21 +02:00
* `Area-Build` : build issues
2017-03-05 07:51:21 +01:00
* `Area-Cmdlets-Core` : cmdlets in the Microsoft.PowerShell.Core module
* `Area-Cmdlets-Utility` : cmdlets in the Microsoft.PowerShell.Utility module
* `Area-Cmdlets-Management` : cmdlets in the Microsoft.PowerShell.Management module
2016-07-22 17:50:21 +02:00
* `Area-Console` : the console experience
* `Area-Debugging` : debugging PowerShell script
2016-08-13 03:19:12 +02:00
* `Area-Demo` : a demo or sample
2016-07-22 17:50:21 +02:00
* `Area-Documentation` : PowerShell *repo* documentation issues, general PowerShell doc issues go [here ](https://github.com/PowerShell/PowerShell-Docs/issues )
2017-01-12 01:58:58 +01:00
* `Area-DSC` : DSC related issues
2016-07-22 17:50:21 +02:00
* `Area-Engine` : core PowerShell engine, interpreter, runtime
2016-08-13 03:19:12 +02:00
* `Area-HelpSystem` : anything related to the help infrastructure and formatting of help
2016-07-22 17:50:21 +02:00
* `Area-Intellisense` : tab completion
* `Area-Language` : parser, language semantics
* `Area-OMI` : omi
* `Area-PackageManagement` : PackageManagement related issues
2016-08-01 20:21:55 +02:00
* `Area-Performance` : a performance issue
2016-07-22 17:50:21 +02:00
* `Area-Portability` : anything affecting script portability
2016-08-13 03:19:12 +02:00
* `Area-PowerShellGet` : PowerShellGet related issues
2017-03-05 07:51:21 +01:00
* `Area-Providers` : PowerShell providers like FileSystem, Certificates, Registry, etc...
2017-03-28 01:44:28 +02:00
* `Area-PSReadline` : PSReadline related issues
2016-08-22 17:46:11 +02:00
* `Area-Remoting` : PSRP issues with any transport layer
2017-03-05 07:51:21 +01:00
* `Area-Security` : security related areas like [JEA ](https://github.com/powershell/JEA )
2016-08-13 03:19:12 +02:00
* `Area-SideBySide` : side by side support
2016-12-01 20:19:02 +01:00
* `Area-Test` : issues in a test or in test infrastructure
2016-07-11 18:42:22 +02:00
2016-09-07 20:32:31 +02:00
### Operating Systems
2016-07-11 18:42:22 +02:00
2016-09-07 20:32:31 +02:00
These are for issues that are specific to certain Operating Systems:
2016-07-11 18:42:22 +02:00
* `OS-Linux`
2016-08-26 21:08:50 +02:00
* `OS-macOS`
2016-07-11 18:42:22 +02:00
* `OS-Windows`
2016-08-18 06:05:39 +02:00
* `OS-WSL` : Windows Subsystem for Linux
2016-07-20 00:18:10 +02:00
### Process Tags
2016-07-22 17:50:21 +02:00
2016-08-13 03:19:12 +02:00
The following labels are used on PRs:
2016-11-16 01:54:07 +01:00
* `Review - Needed` : The PR is being reviewed. Please see [Pull Request - Code Review ](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---code-review )
2016-08-13 03:19:12 +02:00
* `Review - Waiting on Author` : The PR was reviewed by the team and requires changes or comments from the author before being accepted.
2016-09-07 20:32:31 +02:00
* `Review - Abandoned` : The PR was not updated for significant number of days (the exact number could vary over time).
2016-09-03 01:39:27 +02:00
Maintainers should look into such PRs and re-evaluate them.
2016-12-01 20:19:02 +01:00
* `Review - Committee` : The PR/Issue needs a review from [powershell-committee ](../community/governance.md#powershell-committee )
2016-08-13 03:19:12 +02:00
2016-09-07 20:32:31 +02:00
### Miscellaneous labels
2016-07-22 17:50:21 +02:00
2016-12-01 20:19:02 +01:00
* `Committee-Reviewed` : The PR/Issue has been reviewed by the [powershell-committee ](../community/governance.md#powershell-committee )
2016-11-16 01:54:07 +01:00
* `Up-for-Grabs` : We've acknowledged the issue but have no immediate plans to address it.
If you're looking for a way to contribute, these issues can be a good place to start.
2016-08-13 03:19:12 +02:00
* `Blocked` : an issue cannot be addressed due to external factors,
but should not be closed because those external factors are temporary.
* `BVT/DRT` : an issue affecting or exposed by tests that have not been open sourced.
* `Porting` : an issue that affects a feature not yet ported to other platforms.
* `Usability` : this label is used to help us filter issues that might be higher priority
because they more directly affect the usability of a particular feature or area.
* `Changelog Needed` : The PR requires an addition to the changelog,
and should be removed when it has been added.
2017-06-06 17:56:26 +02:00
* `Documentation Needed` : The PR has changes that require a documentation change or new documentation added to [PowerShell-Docs ](http://github.com/powershell/powershell-docs )