From e1f929b0cae6aafbc50ef9013011fb65f72d0adc Mon Sep 17 00:00:00 2001 From: Andrew David Wong Date: Thu, 27 May 2021 21:33:04 -0700 Subject: [PATCH] Move issue template guideline up and update wording --- introduction/reporting-bugs.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/introduction/reporting-bugs.md b/introduction/reporting-bugs.md index 7cc10a2b07..b4f4dccdc0 100644 --- a/introduction/reporting-bugs.md +++ b/introduction/reporting-bugs.md @@ -62,6 +62,18 @@ This includes, but is not limited to, troubleshooting questions and questions ab Instead, see [Help, Support, Mailing Lists, and Forum](/support/) for appropriate place to ask questions. By contrast, [qubes-issues](https://github.com/QubesOS/qubes-issues/issues) is meant for tracking more general bugs, enhancements, and tasks that affect a broad range of Qubes users. +### Use the issue template ### + +When you open a new issue, an issue template is provided for you. +Please use it. +Do not delete it. +The issue template is carefully designed to elicit important information. +Without this information, the issue is likely to be incomplete. +(If certain sections are not applicable, you may remove them, but please do so only sparingly and only if they are *truly* not applicable.) + +It is also important to note the placement and content of the HTML comments in the issue template. +These help us to have issues with a consistent format. + ### Every issue must be about a single, actionable thing ### If your issue is not actionable, please see [Help, Support, Mailing Lists, and Forum](/support/) for the appropriate place to post it. @@ -102,16 +114,6 @@ If you're reporting a bug in a package that is in a [testing](/doc/testing/) rep Project maintainers really appreciate thorough explanations. It usually helps them address the problem more quickly, so everyone wins! -### Use the provided issue template ### - -Please use the provided issue template. -Do not delete it or remove parts of it. -The issue template is carefully designed to elicit important information. -Without this information, the issue is likely to be incomplete. - -It is also important to note the placement and content of the HTML comments in the issue template. -These help us to have issues with a consistent format. - ### There are no guarantees that your issue will be addressed ### Keep in mind that `qubes-issues` is an issue tracker, not a support system.