Simplified bug reporting template

The prior version was a little too optimistic and more difficult
to fill in for the average user
This commit is contained in:
icex2 2021-08-15 11:11:06 +02:00
parent 400a07a481
commit 8e63a74c76

View File

@ -1,107 +1,26 @@
# Bug Report # Bug Report
## Summary ## Description of the bug
<!--- Provide a general summary of the issue in the Title above -->
## Expected behavior
<!--- Tell us what should happen -->
## Current behavior
<!--- Tell us what happens instead of the expected behavior -->
## Detailed Description
<!--- Provide a detailed description of the issue. Include links to screenshots or videos if necessary -->
## Steps to reproduce
<!-- Try running the game with a default configuration as well. If that also causes issues, please point that out here
in the report. This might speed up the debugging process.-->
<!--- Provide a detailed step by step description how to reproduce this issue -->
1.
2.
3.
4.
## Possible solution
<!--- Optional, but suggest a fix/reason for the bug -->
## Context (Environment)
### Segatools version(s) affected
* <!--- Add one or multiple versions as a bullet list -->
### Game(s) and version(s) affected
* <!--- Add one or multiple game versions as a bullet list -->
### Log output
See attachment.
<!--- <!---
Provide FULL log output as a text file. Please do not guess which things are relevant or not. Without knowing, you - Detailed description of issue
might leave out things that are relevant for the developers. You have to enable log output explicitly if not done - Steps to reproduce, e.g. 1. do this, 2. do that
already. - Include configuration files, e.g. segatools.ini
- Include log files
In the start.bat file, modify the command running inject to output stdout and stderr to a file, e.g. segatools.log by - Include screenshots/videos
appending ` > segatools.log 2>&1` to the end of the line, e.g. example for chunihook's start.bat:
```
inject -d -k chunihook.dll chuniApp.exe > segatools.log 2>&1
```
!!!!!!
REMOVE ANY SENSITIVE DATA LIKE DEVICE NAMES BY REPLACING IT THEM WITH
[REDACTED]
BEFORE UPLOADING/POSTING ANY LOG DATA!!!
Use the search and replace feature of any kind of text editor.
!!!!!!
--> -->
### Configuration files ## Affected games and versions
See attachment. <!--- Add one or multiple game versions as a bullet list -->
<!--- Provide any configuration files that you used, e.g. segatools.ini. This file is located in ## Segatools versions tested
the same directory as inject.exe.
!!!!!! <!--- Add one or multiple versions as a bullet list -->
REMOVE ANY SENSITIVE DATA LIKE DEVICE NAMES BY REPLACING IT THEM WITH
[REDACTED] ## OS and hardware specs
BEFORE UPLOADING/POSTING ANY LOG DATA!!!
Use the search and replace feature of any kind of text editor.
!!!!!!
-->
### Command line arguments
<!--- Provide how you run the game from the command line, e.g. which start.bat you used and any
additional arguments that you provided to it. Also provide the contents of the start.bat you
used if you altered it. -->
### APIs used
* <!--- List all APIs and versions you used as a bullet list, e.g. chunihook 1.00 -->
### OS version
<!--- Provide the version of Windows you used with whatever update/build identifier -->
### Hardware specs
* OS: <!--- Provide the version of Windows you used with whatever update/build identifier -->
* CPU: <!--- Insert, e.g. Core i7 2600k 3.20ghz --> * CPU: <!--- Insert, e.g. Core i7 2600k 3.20ghz -->
* RAM: <!--- Insert, e.g. 16 GB --> * RAM: <!--- Insert, e.g. 16 GB -->
* GPU: <!--- Insert, e.g. Nvidia GeForce GTX 970, 4GB --> * GPU: <!--- Insert, e.g. Nvidia GeForce GTX 970, 4GB -->