From 8a8b6e4abcba7008a5649ac113af499e9b6813ed Mon Sep 17 00:00:00 2001 From: "Olivier Wilkinson (reivilibre)" Date: Wed, 8 Jun 2022 10:34:14 +0100 Subject: [PATCH 1/8] Add a bug report form --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 103 ++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.yml diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml new file mode 100644 index 000000000000..8472ff967ef4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -0,0 +1,103 @@ +name: Bug report +description: Create a report to help us improve +#labels: ["bug", "triage"] +body: + - type: markdown + attributes: + value: | + **THIS IS NOT A SUPPORT CHANNEL!** + **IF YOU HAVE SUPPORT QUESTIONS ABOUT RUNNING OR CONFIGURING YOUR OWN HOME SERVER**, + please ask in **[#synapse:matrix.org](https://matrix.to/#/#synapse:matrix.org)** (using a matrix.org account if necessary). + + If you want to report a security issue, please see https://matrix.org/security-disclosure-policy/ + + This is a bug report template. By following the instructions below and + completing the sections with your information, you will help the us to get all + the necessary data to fix your issue. + + You can also preview your report before submitting it. You may remove sections + that aren't relevant to your particular case. + - type: textarea + id: description + attributes: + label: Description + description: Describe the problem that you are experiencing + validations: + required: true + - type: textarea + id: reproduction_steps + attributes: + label: Steps to reproduce + description: | + Describe the series of steps that leads you to the problem. + + Describe how what happens differs from what you expected. + placeholder: Tell us what you see! + value: | + - list the steps + - that reproduce the bug + - using hyphens as bullet points + validations: + required: true + - type: markdown + attributes: + value: | + IMPORTANT: please answer the following questions, to help us narrow down the problem. + - type: input + id: homeserver + attributes: + label: Homeserver + description: Was this issue identified on matrix.org or another homeserver? + validations: + required: true + - type: input + id: version + attributes: + label: Synapse Version + description: | + What version of Synapse is running? + + You can find the Synapse version by visiting https://yourserver.example.com/_matrix/federation/v1/version + + or with this command: + + ``` + $ curl http://localhost:8008/_synapse/admin/v1/server_version + ``` + + (You may need to replace `localhost:8008` if Synapse is not configured to + listen on that port.) + validations: + required: true + - type: dropdown + id: install_method + attributes: + label: Installation Method + options: + - Docker (matrixdotorg/synapse) + - Debian packages from packages.matrix.org + - pip (from PyPI) + - Other (please mention below) + - type: textarea + id: platform + attributes: + label: Platform + description: | + Tell us about the environment in which your homeserver is operating... + e.g. distro, hardware, if it's running in a vm/container, etc. + - type: textarea + id: logs + attributes: + 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. + + Please be careful to remove any personal or private data. + + **Bug reports are usually very difficult to diagnose without logging.** + render: shell + - type: textarea + id: anything_else + attributes: + label: Anything else that would be useful to know? From 788672de0a5e47d2175d174a9b624582d0e117dd Mon Sep 17 00:00:00 2001 From: "Olivier Wilkinson (reivilibre)" Date: Wed, 8 Jun 2022 10:34:25 +0100 Subject: [PATCH 2/8] Remove the bug report 'template' that is hard to read and easy to ignore --- .github/ISSUE_TEMPLATE/BUG_REPORT.md | 72 ---------------------------- 1 file changed, 72 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.md diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md deleted file mode 100644 index 978b6998866c..000000000000 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve - ---- - - - -### Description - - - -### Steps to reproduce - -- list the steps -- that reproduce the bug -- using hyphens as bullet points - - - -### Version information - - - - -- **Homeserver**: - -If not matrix.org: - - -- **Version**: - -- **Install method**: - - -- **Platform**: - From 244bc398590f1a0310db1cafddbb649a1bcdca38 Mon Sep 17 00:00:00 2001 From: "Olivier Wilkinson (reivilibre)" Date: Wed, 8 Jun 2022 10:35:57 +0100 Subject: [PATCH 3/8] Newsfile Signed-off-by: Olivier Wilkinson (reivilibre) --- changelog.d/12982.misc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/12982.misc diff --git a/changelog.d/12982.misc b/changelog.d/12982.misc new file mode 100644 index 000000000000..036b69efe6ee --- /dev/null +++ b/changelog.d/12982.misc @@ -0,0 +1 @@ +Use a GitHub form for issues rather than a hard-to-read, easy-to-ignore template. \ No newline at end of file From 77eedb6189863f417fdf71430834783e6eefdaad Mon Sep 17 00:00:00 2001 From: reivilibre Date: Wed, 8 Jun 2022 11:34:24 +0100 Subject: [PATCH 4/8] Apply suggestions from code review Co-authored-by: Brendan Abolivier --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index 8472ff967ef4..b484ef11b93a 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -11,12 +11,11 @@ body: If you want to report a security issue, please see https://matrix.org/security-disclosure-policy/ - This is a bug report template. By following the instructions below and + This is a bug report form. By following the instructions below and completing the sections with your information, you will help the us to get all the necessary data to fix your issue. - You can also preview your report before submitting it. You may remove sections - that aren't relevant to your particular case. + You can also preview your report before submitting it. - type: textarea id: description attributes: @@ -47,7 +46,7 @@ body: id: homeserver attributes: label: Homeserver - description: Was this issue identified on matrix.org or another homeserver? + description: Which homeserver was this issue identified on? (matrix.org, another homeserver, etc) validations: required: true - type: input @@ -55,7 +54,7 @@ body: attributes: label: Synapse Version description: | - What version of Synapse is running? + What version of Synapse is this homeserver running? You can find the Synapse version by visiting https://yourserver.example.com/_matrix/federation/v1/version From fab51a8fcf954cc6369eeba36f247c216758b37e Mon Sep 17 00:00:00 2001 From: "Olivier Wilkinson (reivilibre)" Date: Wed, 8 Jun 2022 11:36:56 +0100 Subject: [PATCH 5/8] Add more requirements --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index b484ef11b93a..4f583d1ec56b 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -1,6 +1,5 @@ name: Bug report description: Create a report to help us improve -#labels: ["bug", "triage"] body: - type: markdown attributes: @@ -84,6 +83,8 @@ body: description: | Tell us about the environment in which your homeserver is operating... e.g. distro, hardware, if it's running in a vm/container, etc. + validations: + required: true - type: textarea id: logs attributes: @@ -96,6 +97,8 @@ body: **Bug reports are usually very difficult to diagnose without logging.** render: shell + validations: + required: true - type: textarea id: anything_else attributes: From 3b98d9759f4e1a053cd1c6b1e2aebaa5e523d084 Mon Sep 17 00:00:00 2001 From: "Olivier Wilkinson (reivilibre)" Date: Wed, 8 Jun 2022 11:41:09 +0100 Subject: [PATCH 6/8] Remove midsentence line breaks --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index 4f583d1ec56b..6b32e9ff73f8 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -5,14 +5,11 @@ body: attributes: value: | **THIS IS NOT A SUPPORT CHANNEL!** - **IF YOU HAVE SUPPORT QUESTIONS ABOUT RUNNING OR CONFIGURING YOUR OWN HOME SERVER**, - please ask in **[#synapse:matrix.org](https://matrix.to/#/#synapse:matrix.org)** (using a matrix.org account if necessary). + **IF YOU HAVE SUPPORT QUESTIONS ABOUT RUNNING OR CONFIGURING YOUR OWN HOME SERVER**, please ask in **[#synapse:matrix.org](https://matrix.to/#/#synapse:matrix.org)** (using a matrix.org account if necessary). If you want to report a security issue, please see https://matrix.org/security-disclosure-policy/ - This is a bug report form. By following the instructions below and - completing the sections with your information, you will help the us to get all - the necessary data to fix your issue. + This is a bug report form. By following the instructions below and completing the sections with your information, you will help the us to get all the necessary data to fix your issue. You can also preview your report before submitting it. - type: textarea From 284d9b7b01245caacdb67e3878076eeea8f9e3b7 Mon Sep 17 00:00:00 2001 From: reivilibre Date: Wed, 8 Jun 2022 11:43:38 +0100 Subject: [PATCH 7/8] Update .github/ISSUE_TEMPLATE/BUG_REPORT.yml Co-authored-by: Brendan Abolivier --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index 6b32e9ff73f8..aae70c6504c6 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -60,8 +60,7 @@ body: $ curl http://localhost:8008/_synapse/admin/v1/server_version ``` - (You may need to replace `localhost:8008` if Synapse is not configured to - listen on that port.) + (You may need to replace `localhost:8008` if Synapse is not configured to listen on that port.) validations: required: true - type: dropdown From be6b68b8b6a310de75d44dfa8a689128883c1f1a Mon Sep 17 00:00:00 2001 From: "Olivier Wilkinson (reivilibre)" Date: Wed, 8 Jun 2022 11:44:15 +0100 Subject: [PATCH 8/8] Add horizontal rule --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index aae70c6504c6..1b304198bc8f 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -37,7 +37,9 @@ body: - type: markdown attributes: value: | - IMPORTANT: please answer the following questions, to help us narrow down the problem. + --- + + **IMPORTANT**: please answer the following questions, to help us narrow down the problem. - type: input id: homeserver attributes: