mirrors/PowerShell
0
0
Fork 0
mirror of https://github.com/PowerShell/PowerShell.git synced 2024-11-23 17:53:58 +08:00
Code Issues Packages Projects Releases Wiki Activity
7762d7bf49
PowerShell/docs/maintainers/issue-management.md
Steve Lee 9eed401427 Add code cleanup and documentation labels to issue-management.md (#3908) 
* Update issue-management.md to add `code cleanup` and `documentation needed` labels

* changed label to `Documentation Needed` based on feedback
2017-06-06 08:56:26 -07:00

5.0 KiB
Raw Blame History

Issue Management

Long-living issue labels

=======

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
  • Issue-Code Cleanup: the issue is for cleaning up the code with no impact on functionality
  • Issue-Discussion: the issue may not have a clear classification yet. The issue may generate an RFC or may be reclassified as a bug or enhancement.
  • Issue-Enhancement: the issue is more of a feature request than a bug.
  • Issue-Meta: an issue used to track multiple issues.
  • 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.

When an issue is resolved, the following labels are used to describe the resolution:

  • 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.
  • Resolution-External: the issue cannot be address by this repo. Should be addressed externally.
  • Resolution-Fixed: the issue has been fixed and should be referenced from a PR.
  • 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.

Feature areas

These labels describe what feature area of PowerShell that an issue affects:

  • Area-Build: build issues
  • 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
  • Area-Console: the console experience
  • Area-Debugging: debugging PowerShell script
  • Area-Demo: a demo or sample
  • Area-Documentation: PowerShell repo documentation issues, general PowerShell doc issues go here
  • Area-DSC: DSC related issues
  • Area-Engine: core PowerShell engine, interpreter, runtime
  • Area-HelpSystem: anything related to the help infrastructure and formatting of help
  • Area-Intellisense: tab completion
  • Area-Language: parser, language semantics
  • Area-OMI: omi
  • Area-PackageManagement: PackageManagement related issues
  • Area-Performance: a performance issue
  • Area-Portability: anything affecting script portability
  • Area-PowerShellGet: PowerShellGet related issues
  • Area-Providers: PowerShell providers like FileSystem, Certificates, Registry, etc...
  • Area-PSReadline: PSReadline related issues
  • Area-Remoting: PSRP issues with any transport layer
  • Area-Security: security related areas like JEA
  • Area-SideBySide: side by side support
  • Area-Test: issues in a test or in test infrastructure

Operating Systems

These are for issues that are specific to certain Operating Systems:

  • OS-Linux
  • OS-macOS
  • OS-Windows
  • OS-WSL: Windows Subsystem for Linux

Process Tags

The following labels are used on PRs:

  • Review - Needed : The PR is being reviewed. Please see Pull Request - Code Review
  • Review - Waiting on Author : The PR was reviewed by the team and requires changes or comments from the author before being accepted.
  • Review - Abandoned : The PR was not updated for significant number of days (the exact number could vary over time). Maintainers should look into such PRs and re-evaluate them.
  • Review - Committee : The PR/Issue needs a review from powershell-committee

Miscellaneous labels

  • Committee-Reviewed : The PR/Issue has been reviewed by the powershell-committee
  • 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.
  • 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.
  • Documentation Needed : The PR has changes that require a documentation change or new documentation added to PowerShell-Docs