From 984bf67d84471ddfaf1d88c393c0f75454966e0e Mon Sep 17 00:00:00 2001 From: MSuih Date: Wed, 20 Jul 2022 22:22:12 +0300 Subject: [PATCH] Replace issue templates with issue forms (#12373) --- .github/ISSUE_TEMPLATE/1-regression-report.md | 66 ------------- .../ISSUE_TEMPLATE/1-regression-report.yml | 93 +++++++++++++++++++ .github/ISSUE_TEMPLATE/2-bug-report.md | 59 ------------ .github/ISSUE_TEMPLATE/2-bug-report.yml | 73 +++++++++++++++ .github/ISSUE_TEMPLATE/3-feature-request.md | 41 -------- .github/ISSUE_TEMPLATE/3-feature-request.yml | 30 ++++++ .github/ISSUE_TEMPLATE/4-advanced.md | 14 +++ 7 files changed, 210 insertions(+), 166 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/1-regression-report.md create mode 100644 .github/ISSUE_TEMPLATE/1-regression-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/2-bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/2-bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/3-feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/3-feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/4-advanced.md diff --git a/.github/ISSUE_TEMPLATE/1-regression-report.md b/.github/ISSUE_TEMPLATE/1-regression-report.md deleted file mode 100644 index b7cca103e9..0000000000 --- a/.github/ISSUE_TEMPLATE/1-regression-report.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -name: Regression report -about: If something used to work before, but now it doesn't -title: '' -labels: '' -assignees: '' - ---- - -## Please do not ask for help or report compatibility regressions here, use [RPCS3 Discord server](https://discord.me/RPCS3) or [forums](https://forums.rpcs3.net/) instead. - -## Quick summary -Please briefly describe what has stopped working correctly. - -## Details -Please describe the regression as accurately as possible. - -#### 0. Make sure you're running with settings as close to default as possible -* **Do NOT enable any emulator game patches when reporting issues** -* Only change settings that are required for the game to work - -#### 1. Please provide _exact_ build (or commit) information that introduced the regression you're reporting. -* Please see [How to find the build that caused a regression](https://wiki.rpcs3.net/index.php?title=Help:Using_different_versions_of_RPCS3#How_to_find_the_build_that_caused_a_regression.3F) in our wiki. -* You can find [History of RPCS3 builds](https://rpcs3.net/compatibility?b) here. - -#### 2. Please attach TWO logs: -* One for the build with regression. -* One for the build that works as expected. - -##### How to obtain RPCS3's log: -* Run the game until you find the regression. -* Completely close RPCS3, or move to the next step in case it has crashed. -* Locate RPCS3's log file: - + ```RPCS3.log``` (It can show up as just RPCS3 and have a notepad icon) - or - + ```RPCS3.log.gz``` (It can show up as RPCS3.log and have a zip or rar icon) -![image](https://user-images.githubusercontent.com/44116740/84433247-aa15fa80-ac36-11ea-913e-6fe25a1d040e.png) - On Linux it will be in ```~/.cache/rpcs3/```. - On Windows it will be near the executable. -* Attach the log: - + Drag and drop your log file into the issue. - + Or upload it to the cloud, such as Dropbox, Mega etc. - -#### 3. If you describe graphical regression, please provide an RSX capture and a RenderDoc capture that demonstrate it. -* To create an RSX capture, use _Create_ _RSX_ _Capture_ under _Utilities_. -Captures will be stored in RPCS3 folder → captures. - + Compress your capture with 7z, Rar etc. - And drag and drop it into the issue. - + Or upload it to the cloud, such as Dropbox, Mega etc. -* To create a RenderDoc capture, please refer to [RenderDoc's documentation](https://renderdoc.org/docs/how/how_capture_frame.html). - -#### 4. Please attach screenshots of your problem. -* Enable performance overlay with at least medium level of detail. -You can find it in _Emulator_ tab in _Settings_. - -#### 5. Please provide comparison with real PS3. - -#### 6. Please provide your system configuration: -* OS -* CPU -* GPU -* Driver version -* etc. - -#### Please include. -* Anything else you deem to be important diff --git a/.github/ISSUE_TEMPLATE/1-regression-report.yml b/.github/ISSUE_TEMPLATE/1-regression-report.yml new file mode 100644 index 0000000000..9636b282aa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-regression-report.yml @@ -0,0 +1,93 @@ +name: Regression report +description: If something used to work before, but now it doesn't +title: "[Regression] Enter a title here" +labels: [] +body: + - type: markdown + attributes: + value: | + # Summary + Please do not ask for help or report compatibility regressions here, use [RPCS3 Discord server](https://discord.me/RPCS3) or [forums](https://forums.rpcs3.net/) instead. + - type: textarea + id: quick-summary + attributes: + label: Quick summary + description: Please briefly describe what has stopped working correctly. + validations: + required: true + - type: textarea + id: details + attributes: + label: Details + description: Please describe the regression as accurately as possible. Include screenshots if neccessary. + validations: + required: false + - type: markdown + attributes: + value: | + # Identify the regressed build + Please provide the _exact_ build (or commit) information that introduced the regression you're reporting. + * Please see [How to find the build that caused a regression](https://wiki.rpcs3.net/index.php?title=Help:Using_different_versions_of_RPCS3#How_to_find_the_build_that_caused_a_regression.3F) in our wiki. + * You can find [History of RPCS3 builds](https://rpcs3.net/compatibility?b) here. + + Make sure you're running with settings as close to default as possible + * **Do NOT enable any emulator game patches when reporting issues** + * Only change settings that are required for the game to work + - type: input + id: regressed-build + attributes: + label: Build with regression + description: Provide _exact_ build (or commit) information that introduced the regression you're reporting. + placeholder: v0.0.23-13948-31df99f7 + validations: + required: true + - type: markdown + attributes: + value: | + # Log files + Obtaining the log file: + * Run the game until you find the regression. + * Completely close RPCS3 and locate the log file. + + RPCS3's Log file will be ```RPCS3.log.gz``` (sometimes shows as RPCS3.log with zip icon) or ```RPCS3.log``` (sometimes shows as RPCS3 wtih notepad icon). + * On Windows it will be in the RPCS3 directory near the executable + * On Linux it will be in ```~/.cache/rpcs3/``` + * On MacOS it will be in ```~/Library/Caches/rpcs3```. If you're unable to locate it copy paste the path in Spotlight and hit enter. + - type: textarea + id: logs + attributes: + label: Attach two log files + description: | + Attach one file for the build with regression and another for a build that works. + Drag & drop the files into this input field, or upload them to another service (f.ex. Dropbox, Mega) and provide a link. + validations: + required: true + - type: markdown + attributes: + value: | + # Other details + If you describe a graphical regression, please provide an RSX capture and/or a RenderDoc capture that demonstrate it. + * To create an RSX capture, use _Create_ _RSX_ _Capture_ under _Utilities_. + * Captures will be stored in RPCS3 folder → captures. + * To create a RenderDoc capture, please refer to [RenderDoc's documentation](https://renderdoc.org/docs/how/how_capture_frame.html). + - type: textarea + id: captures + attributes: + label: Attach capture files for visual issues + description: Compress your capture with 7z, Rar etc. and attach it here, or upload it to the cloud (Dropbox, Mega etc) and add a link to it. + validations: + required: false + - type: textarea + id: system-info + attributes: + label: System configuration + description: Provide information about your system, such as operating system, CPU and GPU model, GPU driver version and other information that describes your system configuration. + validations: + required: false + - type: textarea + id: other-details + attributes: + label: Other details + description: Include anything else you deem to be important. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/2-bug-report.md b/.github/ISSUE_TEMPLATE/2-bug-report.md deleted file mode 100644 index 9019e16326..0000000000 --- a/.github/ISSUE_TEMPLATE/2-bug-report.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -name: Bug report -about: If something doesn't work correctly in RPCS3 -title: '' -labels: '' -assignees: '' - ---- - -## Please do not ask for help or report compatibility regressions here, use [RPCS3 Discord server](https://discord.me/RPCS3) or [forums](https://forums.rpcs3.net/) instead. - -## Quick summary -Please briefly describe what is not working correctly. - -## Details - -Please describe the problem as accurately as possible. - -#### 0. Make sure you're running with settings as close to default as possible -* **Do NOT enable any emulator game patches when reporting issues** -* Only change settings that are required for the game to work - -#### 1. Please attach RPCS3's log. -* Run the game until you find the issue. -* Completely close RPCS3, or move to the next step in case it has crashed. -* Locate RPCS3's log file: - + ```RPCS3.log``` (It can show up as just RPCS3 and have a notepad icon) - or - + ```RPCS3.log.gz``` (It can show up as RPCS3.log and have a zip or rar icon) -![image](https://user-images.githubusercontent.com/44116740/84433247-aa15fa80-ac36-11ea-913e-6fe25a1d040e.png) - On Linux it will be in ```~/.cache/rpcs3/```. - On Windows it will be near the executable. -* Attach the log: - + Drag and drop your log file into the issue. - + Or upload it to the cloud, such as Dropbox, Mega etc. - -#### 2. If you describe graphical issue, please provide an RSX capture and a RenderDoc capture that demonstrate it. -* To create an RSX capture, use _Create_ _RSX_ _Capture_ under _Utilities_. -Captures will be stored in RPCS3 folder → captures. - + Compress your capture with 7z, Rar etc. - And drag and drop it into the issue. - + Or upload it to the cloud, such as Dropbox, Mega etc. -* To create a RenderDoc capture, please refer to [RenderDoc's documentation](https://renderdoc.org/docs/how/how_capture_frame.html). - -#### 3. Please attach screenshots of your problem. -* Enable performance overlay with at least medium level of detail. -You can find it in _Emulator_ tab in _Settings_. - -#### 4. Please provide comparison with real PS3. - -#### 5. Please provide your system configuration: -* OS -* CPU -* GPU -* Driver version -* etc. - -#### Please include. -* Anything else you deem to be important diff --git a/.github/ISSUE_TEMPLATE/2-bug-report.yml b/.github/ISSUE_TEMPLATE/2-bug-report.yml new file mode 100644 index 0000000000..88ab0137ee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-bug-report.yml @@ -0,0 +1,73 @@ +name: Bug report +description: If something doesn't work correctly in RPCS3 +title: "Enter a title here" +labels: [] +body: + - type: markdown + attributes: + value: | + # Summary + Please do not ask for help or report compatibility regressions here, use [RPCS3 Discord server](https://discord.me/RPCS3) or [forums](https://forums.rpcs3.net/) instead. + - type: textarea + id: quick-summary + attributes: + label: Quick summary + description: Please briefly describe what is not working correctly. + validations: + required: true + - type: textarea + id: details + attributes: + label: Details + description: | + Please describe the problem as accurately as possible. + Provide a comparison with a real PS3, if possible. + validations: + required: false + - type: markdown + attributes: + value: | + # Log files + Obtaining the log file: + * Run the game until you find the regression. + * Completely close RPCS3 and locate the log file. + + RPCS3's Log file will be ```RPCS3.log.gz``` (sometimes shows as RPCS3.log with zip icon) or ```RPCS3.log``` (sometimes shows as RPCS3 wtih notepad icon). + * On Windows it will be in the RPCS3 directory near the executable + * On Linux it will be in ```~/.cache/rpcs3/``` + * On MacOS it will be in ```~/Library/Caches/rpcs3```. If you're unable to locate it copy paste the path in Spotlight and hit enter. + - type: textarea + id: logs + attributes: + label: Attach a log file + description: | + Drag & drop the files into this input field, or upload them to another service (f.ex. Dropbox, Mega) and provide a link. + - type: markdown + attributes: + value: | + # Other details + If you describe a graphical issue, please provide an RSX capture and/or a RenderDoc capture that demonstrate it. + * To create an RSX capture, use _Create_ _RSX_ _Capture_ under _Utilities_. + * Captures will be stored in RPCS3 folder → captures. + * To create a RenderDoc capture, please refer to [RenderDoc's documentation](https://renderdoc.org/docs/how/how_capture_frame.html). + - type: textarea + id: captures + attributes: + label: Attach capture files for visual issues + description: Compress your capture with 7z, Rar etc. and attach it here, or upload it to the cloud (Dropbox, Mega etc) and add a link to it. + validations: + required: false + - type: textarea + id: system-info + attributes: + label: System configuration + description: Provide information about your system, such as operating system, CPU and GPU model, GPU driver version and other information that describes your system configuration. + validations: + required: false + - type: textarea + id: other-details + attributes: + label: Other details + description: Include anything else you deem to be important. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/3-feature-request.md b/.github/ISSUE_TEMPLATE/3-feature-request.md deleted file mode 100644 index 93bc14ce2d..0000000000 --- a/.github/ISSUE_TEMPLATE/3-feature-request.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -name: Feature Request -about: If RPCS3 lacks a feature you would like to see -title: '[Feature Request] Enter Feature Title Here' -labels: '' -assignees: '' - ---- - -## Please do not ask for help or report compatibility regressions here, use [RPCS3 Discord server](https://discord.me/RPCS3) or [forums](https://forums.rpcs3.net/) instead. - -## Quick summary -Please briefly describe what feature you would like RPCS3 to have. - -## Details - -Please describe the feature as accurately as possible. - -#### 1. Please describe, what part of RPCS3 would be affected by your feature: -* Gameplay -* Debugging -* UI -* Patches -* Installation -* Github -* CI -* etc. - -#### 2. Please tell us, why your feature is important to RPCS3. - -#### 3. Please attach screenshots of the feature implemented in other projects. - -#### 4. Please provide your system configuration: -* OS -* CPU -* GPU -* Driver version -* etc. - -#### Please include. -* Anything else you deem to be important \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/3-feature-request.yml b/.github/ISSUE_TEMPLATE/3-feature-request.yml new file mode 100644 index 0000000000..87bee1c2a3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-feature-request.yml @@ -0,0 +1,30 @@ +name: Feature request +description: If RPCS3 lacks a feature you would like to see +title: "[Feature request] Enter a title here" +labels: [] +body: + - type: markdown + attributes: + value: | + Please do not ask for help or report compatibility regressions here, use [RPCS3 Discord server](https://discord.me/RPCS3) or [forums](https://forums.rpcs3.net/) instead. + - type: textarea + id: quick-summary + attributes: + label: Quick summary + description: Please briefly describe what feature you would like RPCS3 to have. + validations: + required: true + - type: markdown + attributes: + value: | + Please include the following information: + * What part of RPCS3 would be affected by your feature? (Gameplay, Debugging, UI, Patches, Installation, CI etc.) + * Why your feature is important to RPCS3. + * If the feature is implemented in other projects, attach screenshots. + - type: textarea + id: details + attributes: + label: Details + description: Please describe the feature as accurately as possible. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/4-advanced.md b/.github/ISSUE_TEMPLATE/4-advanced.md new file mode 100644 index 0000000000..c1dcd50ec5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4-advanced.md @@ -0,0 +1,14 @@ +--- +name: Advanced +about: For developers and experienced users only +title: '' +labels: '' +assignees: '' + +--- + +## Please do not ask for help or report compatibility regressions here, use [RPCS3 Discord server](https://discord.me/RPCS3) or [forums](https://forums.rpcs3.net/) instead. + +You're using the advanced template. You're expected to know what to fill in all the required information for proper report. + +If you're unsure on what to do, please return back to the issue type selection and choose different category. \ No newline at end of file