@samitouri / QOSAMI-WSL-1 / commits / a1bbe40d

Bring back "actionable and reproducible" verbiage in the issue (#3733)

template preamble. Reword to be less shouty. Refresh issue label descriptions in the README. Back-reference the issue template for tag need-repro.

therealkenc committed Jan 2, 2019 at 09:46 UTC a1bbe40d3af3b8eaec2815c8856d14248cd287a3
2 files changed +24 -16
ISSUE_TEMPLATE.md
+2 -2
@@ -1,4 +1,4 @@
1 -This bug-tracker is monitored by developers and other technical types. We like detail! So please use this form and tell us, concisely but precisely, what's up. Please fill out ALL THE FIELDS! Issues with missing or incomplete issue templates will be closed.
1 +Please use the following bug reporting template to help produce issues which are actionable and reproducible, including **all** command-line steps necessary to induce the failure condition. Please fill out **all** the fields! Issues with missing or incomplete issue templates will be closed.
2
3 If you have a feature request, please post to [the UserVoice](https://wpdev.uservoice.com/forums/266908).
4
@@ -10,7 +10,7 @@ If this is a console issue (a problem with layout, rendering, colors, etc.), ple
10 **Please fill out the below information:**
11 * Your Windows build number: (Type `ver` at a Windows Command Prompt)
12
13 -* What you're doing and what's happening: (Copy&paste specific commands and their output, or include screen shots)
13 +* What you're doing and what's happening: (Copy&paste the full set of _specific_ command-line steps necessary to reproduce the behavior, and their output. Include screen shots if that helps demonstrate the problem.)
14
15 * What's wrong / what should be happening instead:
16
README.md
+22 -14
@@ -1,34 +1,42 @@
1 -This repo is for the reporting of issues found within and when using Windows Subsystem for Linux.
1 +This repo is for the reporting of issues found within and when using Windows Subsystem for Linux. Please read [CONTRIBUTING.md](https://github.com/Microsoft/WSL/blob/master/CONTRIBUTING.md) before making an issue submission.
2 +
3 - Do not open Github issues for Windows crashes (BSODs) or security issues. Please direct all Windows crashes and security issues to secure@microsoft.com. Issues with security vulnerabilities may be edited to hide the vulnerability details.
4
5 ## Reporting issues in Windows Console or WSL text rendering/user experience
5 -Note that WSL distro's launch in the Windows Console (unless you have taken steps to launch a 3rd party console/terminal). Therefore, *please file UI/UX related issues in the [Windows Console issue tracker](https://github.com/microsoft/console)*.
6 +Note that WSL distro's launch in the Windows Console (unless you have taken steps to launch a 3rd party console/terminal). Therefore, *please file UI/UX related issues in the [Windows Console issue tracker](https://github.com/microsoft/console)*.
7
7 -### Labels:
8 +## Labels:
9
9 -This and our [User Voice page](https://wpdev.uservoice.com/forums/266908-command-prompt-console-bash-on-ubuntu-on-windo/category/161892-bash) are your best ways to interact directly with the Windows Subsystem for Linux teams. We will be monitoring and responding to issues as best we can. Please attempt to avoid filing duplicates of open or closed items when possible. In the spirit of openness we will be tagging issues with the following:
10 +This and our [User Voice page](https://wpdev.uservoice.com/forums/266908-command-prompt-console-bash-on-ubuntu-on-windo/category/161892-bash) are your best ways to interact directly with the Windows Subsystem for Linux teams. We will be monitoring and responding to issues as best we can. Please attempt to avoid filing duplicates of open or closed items when possible. Issues may be tagged with with the following labels:
11
11 -- **bug** – We consider this issue to be a bug internally. This tag is generally for bugs in implemented features, or something we consider to be a “bug level” change. Things marked with Bug have a corresponding bug in on Microsoft’s internal bug tracking system.
12 +- **bug** – The issue considered to be a bug internally by the dev team. This tag is generally for gaps in implemented (read: intended to be working) WSL behavior. Things marked with **bug** have a corresponding bug in on Microsoft’s internal bug tracking system.
13 - Example: No internet connectivity in Bash [(#5)](https://github.com/Microsoft/WSL/issues/5)
14
14 -- **feature** – Denotes something that is not yet implemented. The community should use our [User Voice](https://wpdev.uservoice.com/forums/266908-command-prompt-console-bash-on-ubuntu-on-windo/category/161892-bash) page for voting on which features everyone feels as the most important. The team will take the User Voice page as input in deciding what to work on next.
15 +- **feature** – Denotes something understood as not working and is not yet implemented. The community should use our [User Voice](https://wpdev.uservoice.com/forums/266908-command-prompt-console-bash-on-ubuntu-on-windo/category/161892-bash) page for voting on which features everyone feels as the most important. The team will take the User Voice page as input in deciding what to work on next.
16 - Example: Docker is not working [(#85)](https://github.com/Microsoft/WSL/issues/85)
17
17 -- **discussion** – Denotes a discussion on the board that does not relate to a specific feature.
18 +- **fixinbound** / **fixedinNNNN** – The bug or feature request originally submitted has been addressed in whole or in part. Related or ongoing bug or feature gaps should be opened as a new issue submission if one does not already exist.
19 +
20 +- **duplicate** – The submission is substantially duplicative of an existing issue, and/or has the same underlying cause.
21 +
22 +- **need-repro** – The issue submission is missing fields from the issue [template](https://github.com/Microsoft/WSL/blob/master/ISSUE_TEMPLATE.md), cannot be reproduced with the information provided, or is not actionable.
23 +
24 +- **discussion** / **question** – Submissions which are not a bug report or feature request.
25 - Example: Windows Subsystem for Linux is not open source [(#178)](https://github.com/Microsoft/WSL/issues/178)
26
20 -- **fixinbound** – When possible, we will mark bugs that have been fixed internally. Unfortunately we cannot say specifically when the bug will hit the insider flights.
27 +- **bydesign** / **linux-behavior** – Denotes that an issue that is considered working as intended or would behave analogously on a native Linux kernel.
28
22 -- **bydesign** – Denotes that an issue is raised that we consider is working as intended. We will give some reasoning why this is by design. After one week we will either close the issue or mark as Discussion depending on what comes up.
29 +- **console** – The submission should be directed to the [console issue tracker](https://github.com/microsoft/console/issues)
30
24 -Additional tags may be used to denote specific types of issues. These include items such as network or symlink.
31 +Additional tags may be used to denote specific types of issues.
32
26 -### Closing:
33 +## Closing:
34
35 Issues may be closed by the original poster at any time. We will close issues if:
29 -- One week passes after the change goes out to the Insider Fast ring
30 -- An issue is clearly a dup of another. The duplicate will be linked
31 -- Any discussion that has clearly run its course
36 +- The issue is not a bug or feature request
37 +- The issue has been addressed
38 +- The issue is a duplicate of another issue
39 +- Discussions or questions that have ran their course
40
41 ### Microsoft Links:
42