From b8196eab3fed411b97f0d35805eaf581a0b3ea69 Mon Sep 17 00:00:00 2001 From: Regalis11 Date: Fri, 6 May 2022 16:01:09 +0300 Subject: [PATCH 1/5] Added new bug report form --- .github/ISSUE_TEMPLATE/bug_report.yml | 78 +++++++++++++++++++++++++++ 1 file changed, 78 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 000000000..15778f8c7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,78 @@ +name: Bug Report +description: Found a bug? Help us squash it by making a bug report! +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report a bug! Actionable reports are very important in identifying and fixing bugs, so please fill out all the fields carefully and provide as much information as you can while being concise. Please also note that we get lots of reports and may not always write back to each individually – that does not mean we have not read it. + - type: checkboxes + id: checks + attributes: + label: "Disclaimers" + options: + - label: "I have searched the issue tracker to check if the issue has already been reported." + required: true + - label: "My issue happened while using mods." + required: false + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Please tell us also what you expected should have happened if the game was behaving correctly. + value: "Using the bike horn crashes the game." + validations: + required: true + - type: textarea + id: repro + attributes: + label: Reproduction steps + description: If possible, describe how the developers can get the bug to happen. It is often extremely hard to fix a bug if we don't know how to reproduce it. + value: | + 1. Start a multiplayer campaign + 2. Spawn a bike horn with console commands + 3. Use the bike horn + 4. Observe how the game crashes + render: bash + - type: dropdown + id: prevalence + attributes: + label: Bug prevalence + description: "How often do you or others encounter this bug?" + options: + - Just once + - Happens every now and then + - Happens regularly + - Happens every time I play + validations: + required: true + - type: dropdown + id: version + attributes: + label: Version + description: Which version of the game did the bug happen in? You can see the current version number in the bottom left corner of your screen in the main menu. + options: + - 0.17.15.0 + - Other + validations: + required: true + - type: input + id: otherversion + attributes: + label: "-" + description: If you selected "Other" in the above dropdown because you are e.g. using a custom build, please tell us more about it here. + - type: dropdown + id: operating-systems + attributes: + label: Which operating system did you encounter this bug on? + options: + - Windows + - MacOS + - Linux + validations: + required: true + - type: textarea + id: errors + attributes: + label: Relevant error messages and crash reports + description: If the game produces any text relevant to your issue, please include those in full. You can copy error messages from the in-game console by right clicking the error and selecting "copy". Crash reports will be named crashreport.log or servercrashreport.log and they're automatically generated into the root of the game's installation folder on your computer. You can usually find the game files location through Steam (Right click Barotrauma in your Steam Library -> Properties -> Local files -> Browse local files). + render: shell From 45acf793a5793e847554ee16416ee106eba9b6d1 Mon Sep 17 00:00:00 2001 From: Regalis11 Date: Fri, 6 May 2022 16:01:41 +0300 Subject: [PATCH 2/5] Removed old bug report template --- .github/ISSUE_TEMPLATE/bug_report.md | 22 ---------------------- 1 file changed, 22 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 713a6cf7c..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Bug report -about: Found a bug? Help us squash it by making a bug report! -title: '' -labels: '' -assignees: '' - ---- - -- [ ] I have searched the issue tracker to check if the issue has already been reported. - -**Description** -A clear and concise description of what the bug is. - -**Steps To Reproduce** -If possible, describe how the developers can get the bug to happen (for example, "the game crashes when I try to put handcuffs on a Moloch"). Please also mention whether the bug happened in a multiplayer or single player session. It is often extremely hard to fix a bug if we don't know how to reproduce it. - -**Version** -Which version of the game did the bug happen in. Also, please include the operating system you're using (Windows/Linux/Mac). - -**Additional information** -Add any other context about the problem here. If the bug always occurs in a specific save file or submarine, attaching the file to the report makes it much easier for us to diagnose. Since GitHub doesn't allow attaching the .sub or .save files to reports directly, you need to .zip them first. From ab22de68d7697ca0249d1e288558b85ac9db6f62 Mon Sep 17 00:00:00 2001 From: Regalis11 Date: Fri, 6 May 2022 16:17:48 +0300 Subject: [PATCH 3/5] Changes to the bug report form --- .github/ISSUE_TEMPLATE/bug_report.yml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 15778f8c7..948d670ce 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -19,20 +19,21 @@ body: attributes: label: What happened? description: Please tell us also what you expected should have happened if the game was behaving correctly. - value: "Using the bike horn crashes the game." + placeholder: "Using the bike horn crashes the game." validations: required: true - type: textarea id: repro attributes: label: Reproduction steps - description: If possible, describe how the developers can get the bug to happen. It is often extremely hard to fix a bug if we don't know how to reproduce it. - value: | + description: | + If possible, describe how the developers can get the bug to happen. It is often extremely hard to fix a bug if we don't know how to reproduce it. + If you have a save, a submarine file, screenshots or any other files that might help us diagnose the issue, you can attach them here. Note that GitHub doesn't support the .save or .sub file extensions, so you should .zip those types of files to allow them to be attached. + placeholder: | 1. Start a multiplayer campaign 2. Spawn a bike horn with console commands 3. Use the bike horn 4. Observe how the game crashes - render: bash - type: dropdown id: prevalence attributes: From 54c225790eb3d05088a5d087732c0e7bd7e1fe45 Mon Sep 17 00:00:00 2001 From: Regalis11 Date: Fri, 6 May 2022 16:19:01 +0300 Subject: [PATCH 4/5] Fixed bug report form (I hope?) --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 948d670ce..31ca25b87 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -27,8 +27,8 @@ body: attributes: label: Reproduction steps description: | - If possible, describe how the developers can get the bug to happen. It is often extremely hard to fix a bug if we don't know how to reproduce it. - If you have a save, a submarine file, screenshots or any other files that might help us diagnose the issue, you can attach them here. Note that GitHub doesn't support the .save or .sub file extensions, so you should .zip those types of files to allow them to be attached. + If possible, describe how the developers can get the bug to happen. It is often extremely hard to fix a bug if we don't know how to reproduce it. + If you have a save, a submarine file, screenshots or any other files that might help us diagnose the issue, you can attach them here. Note that GitHub doesn't support the .save or .sub file extensions, so you should .zip those types of files to allow them to be attached. placeholder: | 1. Start a multiplayer campaign 2. Spawn a bike horn with console commands From 3c5142f4a374a07ee6fe76d081e3b86d2cf84d6e Mon Sep 17 00:00:00 2001 From: Regalis11 Date: Fri, 6 May 2022 17:20:55 +0300 Subject: [PATCH 5/5] Test readding the old report form with a different name --- .github/ISSUE_TEMPLATE/bug_report.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..b66371762 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,22 @@ +--- +name: Bug report (old) +about: Please use the other report form to report issues. This old template is only here until we've replaced the bug report links in the game. +title: '' +labels: '' +assignees: '' + +--- + +Please use the other report form to report issues. This old template is only here until we've replaced the bug report links in the game. + +**Description** +A clear and concise description of what the bug is. + +**Steps To Reproduce** +If possible, describe how the developers can get the bug to happen (for example, "the game crashes when I try to put handcuffs on a Moloch"). Please also mention whether the bug happened in a multiplayer or single player session. It is often extremely hard to fix a bug if we don't know how to reproduce it. + +**Version** +Which version of the game did the bug happen in. Also, please include the operating system you're using (Windows/Linux/Mac). + +**Additional information** +Add any other context about the problem here. If the bug always occurs in a specific save file or submarine, attaching the file to the report makes it much easier for us to diagnose. Since GitHub doesn't allow attaching the .sub or .save files to reports directly, you need to .zip them first.