From ad49aa254787619b931699fe4e271ea8f30d80d1 Mon Sep 17 00:00:00 2001 From: Joonas Rikkonen Date: Thu, 28 Mar 2024 13:55:44 +0200 Subject: [PATCH] Update bug_report.yml --- .github/ISSUE_TEMPLATE/bug_report.yml | 111 +++----------------------- 1 file changed, 10 insertions(+), 101 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 9fb331b8c..f910332f9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,102 +1,11 @@ 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. - 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 (or, in other words, what actions lead to you encountering the bug). **This is by far the most important part of the report** - it is often extremely difficult, or even impossible, to diagnose an issue if we don't know the conditions it occurs in. - 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 - validations: - required: true - - 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: mporsp - attributes: - label: Single player or multiplayer? - description: Did the issue happen in single player, multiplayer, or both? How was the server being hosted? - options: - - Single player - - Multiplayer hosted from the in-game menu (= using a listen server) - - Multiplayer hosted using a dedicated server - - Happens in both single player and multiplayer - - Happens outside single player or multiplayer game modes (e.g. game launches on startup, something broken in the main menu) - - Other - validations: - required: true - - type: input - id: othermporsp - attributes: - label: "-" - description: If you selected "Other" in the above dropdown, please clarify here. - - 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: - - v1.2.8.0 (Winter Update hotfix 2) - - v1.2.13.0 (unstable) - - v1.2.8.0 (EOS test build) - - 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 +description: **Tl;Dr: Please write your reports in the [Discussions section](https://github.com/FakeFishGames/Barotrauma/discussions/categories/bug-reports) from now on, and please look for and upvote reports about issues similar to yours.** + +For years, we've directed all bug reports from players to our issue tracker. That was handy because the reports went straight to our programmers. It was also really cumbersome, because we get a lot of reports, and using the issue tracker, we had to investigate them all more closely than we had time for. + +So now we've moved all player reports to the [discussions section](https://github.com/FakeFishGames/Barotrauma/discussions/categories/bug-reports), where we previously directed only feature requests. Why? + +- **Discussions can be upvoted** to show that you have the same issue. This is the number 1 new thing that we'd like everyone to do, as this will help us focus our attention on those issues that are bothering a lot of players. You're also encouraged to chime in on an existing discussion to give more information about it. +- We can turn discussions into tickets with a single click once we pick one to be worked on internally, so this doesn't make our work any more difficult. + +Nothing else changes! Please continue reporting, upvoting, and discussing issues.