forked from Dniel97/segatools
Add gitlab MR and issue templates
Ported with some tweaks from BT5
This commit is contained in:
parent
d6a66b1745
commit
85e644cbd6
108
.gitlab/issue_templates/Bug.md
Normal file
108
.gitlab/issue_templates/Bug.md
Normal file
@ -0,0 +1,108 @@
|
||||
# Bug Report
|
||||
|
||||
## Summary
|
||||
|
||||
<!--- 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
|
||||
might leave out things that are relevant for the developers. You have to enable log output explicitly if not done
|
||||
already.
|
||||
|
||||
In the start.bat file, modify the command running inject to output stdout and stderr to a file, e.g. segatools.log by
|
||||
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
|
||||
|
||||
See attachment.
|
||||
|
||||
<!--- Provide any configuration files that you used, e.g. segatools.ini. This file is located in
|
||||
the same directory as inject.exe.
|
||||
|
||||
!!!!!!
|
||||
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.
|
||||
!!!!!!
|
||||
-->
|
||||
|
||||
### 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
|
||||
|
||||
* CPU: <!--- Insert, e.g. Core i7 2600k 3.20ghz -->
|
||||
* RAM: <!--- Insert, e.g. 16 GB -->
|
||||
* GPU: <!--- Insert, e.g. Nvidia GeForce GTX 970, 4GB -->
|
||||
* Controllers/IO: <!--- Insert, e.g. tasoller with custom firmware -->
|
21
.gitlab/issue_templates/Feature.md
Normal file
21
.gitlab/issue_templates/Feature.md
Normal file
@ -0,0 +1,21 @@
|
||||
# Feature Request
|
||||
|
||||
## Summary
|
||||
|
||||
<!--- Provide a general summary of your changes in the Title above -->
|
||||
|
||||
## Detailed description
|
||||
|
||||
<!--- Describe your feature in detail -->
|
||||
|
||||
## Benefits
|
||||
|
||||
<!--- Describe the value/benefits of the feature in detail -->
|
||||
|
||||
## Drawbacks
|
||||
|
||||
<!--- Describe any drawbacks that might be introduced with this feature -->
|
||||
|
||||
## Current blockers
|
||||
|
||||
<!--- Describe any blockers that need to be resolved before implementing this feature -->
|
34
.gitlab/merge_request_templates/Bugfix.md
Normal file
34
.gitlab/merge_request_templates/Bugfix.md
Normal file
@ -0,0 +1,34 @@
|
||||
# Bugfix
|
||||
|
||||
## Summary
|
||||
|
||||
<!--- Provide a general summary of your changes in the Title above -->
|
||||
|
||||
## Description
|
||||
|
||||
<!--- Describe your changes in detail -->
|
||||
|
||||
## Related Issue
|
||||
|
||||
<!--- This project only accepts pull requests related to open issues -->
|
||||
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
|
||||
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
|
||||
<!--- Please link to the issue here: -->
|
||||
|
||||
## How Has This Been Tested?
|
||||
|
||||
<!--- Please describe in detail how you tested your changes. -->
|
||||
<!--- Include details of your testing environment, and the tests you ran to -->
|
||||
<!--- see how your change affects other areas of the code, etc. -->
|
||||
|
||||
## Checklist
|
||||
|
||||
<!-- Make sure you covered all items, which apply, of the checklist below. -->
|
||||
<!-- Strikethrough items that do not apply and provide a brief description why. -->
|
||||
|
||||
* Tested with the following games:
|
||||
* [ ] ... <!-- insert game name 1-->
|
||||
* [ ] ... <!-- insert game name 2--->
|
||||
* [ ] Followed the developer (style) guidelines.
|
||||
* [ ] Updated existing doc of or add new doc to README file(s)
|
||||
* [ ] Updated development documentation
|
34
.gitlab/merge_request_templates/Feature.md
Normal file
34
.gitlab/merge_request_templates/Feature.md
Normal file
@ -0,0 +1,34 @@
|
||||
# New Feature
|
||||
|
||||
## Summary
|
||||
|
||||
<!--- Provide a general summary of your changes in the Title above -->
|
||||
|
||||
## Description
|
||||
|
||||
<!--- Describe your changes in detail -->
|
||||
|
||||
## Related Issue
|
||||
|
||||
<!--- This project only accepts pull requests related to open issues -->
|
||||
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
|
||||
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
|
||||
<!--- Please link to the issue here: -->
|
||||
|
||||
## How Has This Been Tested?
|
||||
|
||||
<!--- Please describe in detail how you tested your changes. -->
|
||||
<!--- Include details of your testing environment, and the tests you ran to -->
|
||||
<!--- see how your change affects other areas of the code, etc. -->
|
||||
|
||||
## Checklist
|
||||
|
||||
<!-- Make sure you covered all items, which apply, of the checklist below. -->
|
||||
<!-- Strikethrough items that do not apply and provide a brief description why. -->
|
||||
|
||||
* Tested with the following games:
|
||||
* [ ] ... <!-- insert game name 1-->
|
||||
* [ ] ... <!-- insert game name 2--->
|
||||
* [ ] Followed the developer (style) guidelines
|
||||
* [ ] Updated existing doc of or add new doc to README file(s)
|
||||
* [ ] Updated development documentation
|
Loading…
Reference in New Issue
Block a user