From 00ccce5b987997fc5439950015f79c2323d712ad Mon Sep 17 00:00:00 2001 From: David Robertson Date: Tue, 22 Nov 2022 17:17:45 +0000 Subject: [PATCH 1/7] Require response for installation kind --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index 1b304198bc8f..918d16399d6c 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -74,6 +74,9 @@ body: - Debian packages from packages.matrix.org - pip (from PyPI) - Other (please mention below) + - I don't know + validations: + required: true - type: textarea id: platform attributes: From 3c3f80d3848c18aec650a94b4838b412d194d81d Mon Sep 17 00:00:00 2001 From: David Robertson Date: Tue, 22 Nov 2022 17:18:21 +0000 Subject: [PATCH 2/7] Require description of database --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index 918d16399d6c..d44d5a044e8c 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -77,6 +77,20 @@ body: - I don't know validations: required: true + - type: input + id: database + attributes: + label: Database + description: | + Are you using SQLite or PostgreSQL? What's the version of your database? + + If PostgreSQL, please also answer the following: + - are you using a single PostgreSQL server + or [separate servers for `main` and `state`](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#databases)? + - have you previously ported from SQLite using the Synapse "portdb" script? + - have you previously restored from a backup? + validations: + required: true - type: textarea id: platform attributes: From c7e77cd9310ad58917876e2533b7fed1fadc79ca Mon Sep 17 00:00:00 2001 From: David Robertson Date: Tue, 22 Nov 2022 17:18:36 +0000 Subject: [PATCH 3/7] Require user to confirm if they're using workers --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index d44d5a044e8c..adc2fc4c6dbe 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -91,6 +91,19 @@ body: - have you previously restored from a backup? validations: required: true + - type: dropdown + id: workers + attributes: + label: Workers + description: | + Are you running a single Synapse process, or are you running + [2 or more workers](https://matrix-org.github.io/synapse/latest/workers.html)? + options: + - Single process + - Multiple workers + - I don't know + validations: + required: true - type: textarea id: platform attributes: From dbb9525486e795bd52b1faaacae8f70e30326999 Mon Sep 17 00:00:00 2001 From: David Robertson Date: Tue, 22 Nov 2022 17:19:23 +0000 Subject: [PATCH 4/7] Ask if there are any unusual config options turned on --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index adc2fc4c6dbe..2fa6e591b101 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -113,6 +113,17 @@ body: e.g. distro, hardware, if it's running in a vm/container, etc. validations: required: true + - type: textarea + id: config + attributes: + label: Configuration + description: | + Do you have any unusual config options turned on? If so, please provide details. + + - Experimental or undocumented features + - [Presence](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#presence) + - [Message retention](https://matrix-org.github.io/synapse/latest/message_retention_policies.html) + - [Synapse modules](https://matrix-org.github.io/synapse/latest/modules/index.html) - type: textarea id: logs attributes: From 8f6cec8bf7f8f00ecc614d52877f82c1076e5639 Mon Sep 17 00:00:00 2001 From: David Robertson Date: Tue, 22 Nov 2022 17:19:41 +0000 Subject: [PATCH 5/7] Clarify what backticks are for non-native speakers --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index 2fa6e591b101..35820a9424c8 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -130,7 +130,7 @@ body: label: Relevant log output description: | Please copy and paste any relevant log output, ideally at INFO or DEBUG log level. - This will be automatically formatted into code, so there is no need for backticks. + This will be automatically formatted into code, so there is no need for backticks (`\``). Please be careful to remove any personal or private data. From 1f910d8fe5415700130d47f5b4ce9e165b1fda23 Mon Sep 17 00:00:00 2001 From: David Robertson Date: Tue, 22 Nov 2022 17:19:57 +0000 Subject: [PATCH 6/7] Strengthen the "give logs pls" message --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index 35820a9424c8..abe0f656a28b 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -134,7 +134,7 @@ body: Please be careful to remove any personal or private data. - **Bug reports are usually very difficult to diagnose without logging.** + **Bug reports are usually impossible to diagnose without logging.** render: shell validations: required: true From 028e3d5c9728aad30a9c3822d18f13934e29d40c Mon Sep 17 00:00:00 2001 From: David Robertson Date: Tue, 22 Nov 2022 17:22:32 +0000 Subject: [PATCH 7/7] Changelog --- changelog.d/14522.misc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/14522.misc diff --git a/changelog.d/14522.misc b/changelog.d/14522.misc new file mode 100644 index 000000000000..512bc3256783 --- /dev/null +++ b/changelog.d/14522.misc @@ -0,0 +1 @@ +Add more prompts to the bug report form.