From 906c115a97f49a498bc45e167551c3ed14506982 Mon Sep 17 00:00:00 2001 From: rugk Date: Thu, 24 Aug 2023 21:30:25 +0200 Subject: [PATCH 1/3] Make QA template more strict and helpful 1. Require to fill out STRs. 2. Add more fields for client stuff, i.e. web browser and OS. 3. Add more placeholders and descriptions to guide users. 4. Adjust the reproducibility thing to be more clear. I.e. before the result was sth. like "Issue reproducibility: Yes" - this could be confused with "Is it always reproducible? Yes", and not "It is reproducible on our test instance." --- .github/DISCUSSION_TEMPLATE/q-a.yml | 28 +++++++++++++++++++++------- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/.github/DISCUSSION_TEMPLATE/q-a.yml b/.github/DISCUSSION_TEMPLATE/q-a.yml index 00c713a5..6d22b6b5 100644 --- a/.github/DISCUSSION_TEMPLATE/q-a.yml +++ b/.github/DISCUSSION_TEMPLATE/q-a.yml @@ -29,6 +29,8 @@ body: 1. 2. ... + validations: + required: true - type: textarea id: what_happens attributes: @@ -43,35 +45,47 @@ body: id: additional_info attributes: label: Additional information - description: If you have access to the server log files, copy them here. + description: E.g. if you have access to the server log files, copy them here. Or copy the browser console, if appropiate. - type: input id: server_address attributes: label: Server address + description: The instance of PrivateBin, where you experience the issue. + placeholder: e.g. https://privatebin.net - type: input id: server_os attributes: label: Server OS + placeholder: e.g. Ubuntu - type: input id: webserver attributes: label: Webserver - - type: input - id: browser - attributes: - label: Browser + placeholder: e.g. Apache - type: input id: privatebin_version attributes: label: PrivateBin version + description: The PrivateBin version, where you experience the issue. It is shown at the bottom left in the web interface e.g. + placeholder: e.g. v1.5.2 + - type: input + id: browser + attributes: + label: Browser and version + placeholder: e.g. Firefox v116.3.0 (desktop) + - type: input + id: client + attributes: + label: Local operating system and version + placeholder: e.g. Windows 10 - type: dropdown id: reproduce_issue attributes: label: Issue reproducibility description: Can you reproduce this issue on [https://privatebin.net](https://privatebin.net)? options: - - "No" - - "Yes" + - "No, I cannot reproduce it on https://privatebin.net"" + - "Yes, reproducible on https://privatebin.net" default: 0 validations: required: true From 11fd21f8a8786dcc843c3c4294cab8b494c2ba1e Mon Sep 17 00:00:00 2001 From: rugk Date: Thu, 24 Aug 2023 21:32:42 +0200 Subject: [PATCH 2/3] doc: improve wording/grammar --- .github/DISCUSSION_TEMPLATE/q-a.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/DISCUSSION_TEMPLATE/q-a.yml b/.github/DISCUSSION_TEMPLATE/q-a.yml index 6d22b6b5..053e1277 100644 --- a/.github/DISCUSSION_TEMPLATE/q-a.yml +++ b/.github/DISCUSSION_TEMPLATE/q-a.yml @@ -45,7 +45,7 @@ body: id: additional_info attributes: label: Additional information - description: E.g. if you have access to the server log files, copy them here. Or copy the browser console, if appropiate. + description: E.g. if you have access to the server log files, copy them here. Or copy the browser console content, if appropiate. - type: input id: server_address attributes: @@ -66,7 +66,7 @@ body: id: privatebin_version attributes: label: PrivateBin version - description: The PrivateBin version, where you experience the issue. It is shown at the bottom left in the web interface e.g. + description: The PrivateBin version, where you experience the issue. It is e.g. shown at the bottom left in the web interface. placeholder: e.g. v1.5.2 - type: input id: browser @@ -84,8 +84,8 @@ body: label: Issue reproducibility description: Can you reproduce this issue on [https://privatebin.net](https://privatebin.net)? options: - - "No, I cannot reproduce it on https://privatebin.net"" - - "Yes, reproducible on https://privatebin.net" + - "No, I cannot reproduce it on https://privatebin.net." + - "Yes, reproducible on https://privatebin.net." default: 0 validations: required: true From 61457c46c01091b2eab9a7a4ae93119d76798bac Mon Sep 17 00:00:00 2001 From: rugk Date: Thu, 24 Aug 2023 21:35:42 +0200 Subject: [PATCH 3/3] doc: link FAQ in option too The doc says MD is supported for that here, too. --- .github/DISCUSSION_TEMPLATE/q-a.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/DISCUSSION_TEMPLATE/q-a.yml b/.github/DISCUSSION_TEMPLATE/q-a.yml index 053e1277..bc0b06c7 100644 --- a/.github/DISCUSSION_TEMPLATE/q-a.yml +++ b/.github/DISCUSSION_TEMPLATE/q-a.yml @@ -18,7 +18,7 @@ body: label: Did you use the FAQ section? description: Have you read [the FAQ](https://github.com/PrivateBin/PrivateBin/wiki/FAQ)? options: - - label: Yes, I have read the FAQ and I found no solution/answer there. + - label: Yes, I have read [the FAQ](https://github.com/PrivateBin/PrivateBin/wiki/FAQ) and I found no solution/answer there. required: true - type: textarea id: what_you_did