Skip to content

Add code cleanup and documentation labels to issue-management.md #3908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mirichmo merged 2 commits into from
Jun 6, 2017
+2 −0
Merged

Add code cleanup and documentation labels to issue-management.md #3908

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e86ce89
Update issue-management.md
SteveL-MSFT Jun 1, 2017
1d9f1d2
changed label to `Documentation Needed` based on feedback
SteveL-MSFT Jun 5, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/maintainers/issue-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ 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

@iSazonov iSazonov Jun 2, 2017 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe remove the space in the label? This makes it easier to write manual filters in GitHub.

Please clarify - usually we have PRs not Issues with code/test cleanup.

@SteveL-MSFT SteveL-MSFT Jun 2, 2017

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I originally had no space, but looking at some of the other labels we have, I decided to have the space for consistency.

Issue-Code Cleanup is to identify known issues in the code where we should clean up (I've already labeled a number of such issues) that isn't a priority to address so they aren't automatically PRs

* `Issue-Discussion`: the issue may not have a clear classification yet.
The issue may generate an [RFC][ln-rfc] or may be reclassified as a bug or enhancement.
* `Issue-Enhancement`: the issue is more of a feature request than a bug.
Expand Down Expand Up @@ -88,3 +89,4 @@ The following labels are used on PRs:
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](http://github.com/powershell/powershell-docs)