From 906c115a97f49a498bc45e167551c3ed14506982 Mon Sep 17 00:00:00 2001 From: rugk Date: Thu, 24 Aug 2023 21:30:25 +0200 Subject: [PATCH] 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