From c7f9962ddee502030e790a0bfc0f949eaf5910c7 Mon Sep 17 00:00:00 2001 From: Piplup <100526773+piplup55@users.noreply.github.com> Date: Fri, 27 Jan 2023 18:23:55 +0000 Subject: [PATCH] converts the templates into forms (#4068) * Create bug_report.yml * Update bug_report.yml * Update bug_report.yml * Create feature_request.yml * Update feature_request.yml * Update feature_request.yml * Update feature_request.yml * Update feature_request.yml * a * Update missing_cpu_instruction.yml * Update missing_cpu_instruction.yml * Update missing_cpu_instruction.yml * Update missing_cpu_instruction.yml * b * addressed some of the feedback * forget the label * added missing text inputs * formatting changes * dropdown menu added dropdown menu for os, idk if we will keep this * addressed feedback addressed the long overdue feedback, sorry about that * added markdowns everything should be addressed now i hope * game version optional made game version optional after further feedback * feature request checkbox --- .github/ISSUE_TEMPLATE/bug_report.md | 43 ----------- .github/ISSUE_TEMPLATE/bug_report.yml | 75 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 34 --------- .github/ISSUE_TEMPLATE/feature_request.yml | 36 +++++++++ .../ISSUE_TEMPLATE/missing_cpu_instruction.md | 34 --------- .../missing_cpu_instruction.yml | 31 ++++++++ .../ISSUE_TEMPLATE/missing_service_call.md | 35 --------- .../ISSUE_TEMPLATE/missing_service_call.yml | 31 ++++++++ 8 files changed, 173 insertions(+), 146 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/missing_cpu_instruction.md create mode 100644 .github/ISSUE_TEMPLATE/missing_cpu_instruction.yml delete mode 100644 .github/ISSUE_TEMPLATE/missing_service_call.md create mode 100644 .github/ISSUE_TEMPLATE/missing_service_call.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 9c0b18c5..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -name: Bug Report -about: Something doesn't work correctly in Ryujinx. Game-specific issues should be posted at https://github.com/Ryujinx/Ryujinx-Games-List instead, unless it is a provable regression. -#assignees: ---- - -## Bug Report - -[ If any section does not apply, replace its contents with "N/A". ]
-[ Lines between [ ] (square brackets) should be removed before posting. ] - -### What's the issue you encountered? - -[ Describe the issue in detail and what you were doing beforehand. ]
-[ Did you make any changes related to Ryujinx itself? ]
-[ If so, make sure to include details relating to what exactly you changed. ] - -### How can the issue be reproduced? - -[ Include a detailed step by step process for recreating your issue. ] - -### Log file - -[ Logs files can be found under ``Logs`` folder in Ryujinx program folder. ]
-[ If you don't include a crash report in instances of crash related issues, we will ask you one to provide one. ] - -### Environment? - -- Ryujinx version: 1.0.X
-[ Replace X's with the Ryujinx version at time of crash. ] -- Game version: X.X.X
-[ Replace X's with the game version at time of crash. ] -- System Specs: - - OS: *(e.g. Windows 10)* - - CPU: *(e.g. i7-6700)* - - GPU: *(e.g. NVIDIA RTX 2070)* - - RAM: *(e.g. 16GiB)* -- Applied Mods : [ Yes (Which ones) / No ] - -### Additional context? - -Additional info about your environment:
-[ Any other information relevant to your issue. ] diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..a7560fc6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,75 @@ +name: Bug Report +description: File a bug report +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true + - type: textarea + id: issue + attributes: + label: Description of Issue + description: What's the issue you encountered? + validations: + required: true + - type: textarea + id: repro + attributes: + label: Reproduction Steps + description: How can the issue be reproduced? + validations: + required: true + - type: textarea + id: log + attributes: + label: Log File + description: A log file will help our developers to better diagnose and fix the issue. + placeholder: Logs files can be found under "Logs" folder in Ryujinx program folder. You can drag and drop the log on to the text area + validations: + required: true + - type: input + id: os + attributes: + label: OS + placeholder: "Example: Windows 10" + validations: + required: true + - type: input + id: ryujinx-version + attributes: + label: Ryujinx version + placeholder: | + - *(e.g. 1.0.470)* + validations: + required: true + - type: input + id: game-version + attributes: + label: Game version + placeholder: | + - *(e.g. 1.1.1)* + validations: + required: false + - type: textarea + id: environment + attributes: + label: Environment? + value: | + - ##### CPU: *(e.g. i7-6700)* + - ##### GPU: *(e.g. NVIDIA RTX 2070)* + - ##### RAM: *(e.g. 16GB)* + - Applied Mods: [ Yes (Which ones) / No ] + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional context? + description: | + - Additional info about your environment: + - Any other information relevant to your issue. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index f1855f26..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Feature Request -about: Suggest a new feature for Ryujinx. -#assignees: ---- - -## Feature Request - -[ If any section does not apply, replace its contents with "N/A". ]
-[ If you do not have the information needed for a section, replace its contents with "Unknown". ]
-[ Lines between [ ] (square brackets) are to be removed before posting. ]
- -[ Please search for existing [feature requests](https://github.com/Ryujinx/Ryujinx/issues) before you make your own request. ]
-[ Duplicate requests will be marked as such and you will be referred to the original request. ] - -### What feature are you suggesting? -#### Overview: -- [ Include the basic, high-level concepts for this feature here. ] - -#### Smaller Details: -- [ These may include specific methods of implementation etc. ] - -#### Nature of Request: -[ Remove all that do not apply to your request. ] -- Addition - - [ Ex: Addition of certain original features or features from other community projects. ] - - [ If you are suggesting porting features or including features from other projects, include what license they are distributed under and what, if any libraries those project use. ] -- Change -- Removal - - [Ex: Removal of certain features or implementation due to a specific issue/bug or because of low quality code, etc.] - -### Why would this feature be useful? -[ If this is a feature for an end-user, how does it benefit the end-user? ]
-[ If this feature is for developers, what does it add to Ryujinx that did not already exist? ] diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..f755812f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,36 @@ +name: Feature Request +description: Suggest a new feature for Ryujinx. +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the feature you are requesting. + options: + - label: I have searched the existing issues + required: true + - type: textarea + id: overview + attributes: + label: Overview + description: Include the basic, high-level concepts for this feature here. + validations: + required: true + - type: textarea + id: details + attributes: + label: Smaller Details + description: These may include specific methods of implementation etc. + validations: + required: true + - type: textarea + id: request + attributes: + label: Nature of Request + validations: + required: true + - type: textarea + id: feature + attributes: + label: Why would this feature be useful? + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/missing_cpu_instruction.md b/.github/ISSUE_TEMPLATE/missing_cpu_instruction.md deleted file mode 100644 index abfda115..00000000 --- a/.github/ISSUE_TEMPLATE/missing_cpu_instruction.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Missing CPU Instruction -about: CPU Instruction is missing in Ryujinx. -#assignees: ---- - -## Missing CPU Instruction - -[ If any section does not apply, replace its contents with "N/A". ]
-[ If you do not have the information needed for a section, replace its contents with "Unknown". ]
-[ Lines between [ ] (square brackets) are to be removed before posting. ] - -[ Please search for existing [missing CPU instruction](https://github.com/Ryujinx/Ryujinx/issues) before you make your own issue. ]
-[ See the following [issue](https://github.com/Ryujinx/Ryujinx/issues/1405) as an example ]
-[ Duplicate issue will be marked as such and you will be referred to the original request. ] - -### What CPU instruction is missing? - -Requires the *INSTRUCTION* instruction.
-[ Replace *INSTRUCTION* by the instruction name, e.g. VADDL.U16 ] - -``` -* -``` -[ Add the undefined instruction error message in the above code block ] - -### Instruction name -``` -* -``` -[ Include the name from [armconverter.com](https://armconverter.com/?disasm) or [shell-storm.org](http://shell-storm.org/online/Online-Assembler-and-Disassembler/?arch=arm64&endianness=big&dis_with_raw=True&dis_with_ins=True) in the above code block ] - -### Required by: -[ Add our (games list database)[https://github.com/Ryujinx/Ryujinx-Games-List/issues] links of games who require this instruction ] diff --git a/.github/ISSUE_TEMPLATE/missing_cpu_instruction.yml b/.github/ISSUE_TEMPLATE/missing_cpu_instruction.yml new file mode 100644 index 00000000..237e61e9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/missing_cpu_instruction.yml @@ -0,0 +1,31 @@ +name: Missing CPU Instruction +description: CPU Instruction is missing in Ryujinx. +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search for existing missing CPU instruction + options: + - label: I have searched the existing issues + required: true + - type: textarea + id: instruction + attributes: + label: CPU instruction + description: What CPU instruction is missing? + validations: + required: true + - type: textarea + id: name + attributes: + label: Instruction name + description: Include the name from [armconverter.com](https://armconverter.com/?disasm) or [shell-storm.org](http://shell-storm.org/online/Online-Assembler-and-Disassembler/?arch=arm64&endianness=big&dis_with_raw=True&dis_with_ins=True) in the above code block + validations: + required: true + - type: textarea + id: required + attributes: + label: Required by + description: Add links to the [compatibility list page(s)](https://github.com/Ryujinx/Ryujinx-Games-List/issues) of the game(s) that require this instruction. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/missing_service_call.md b/.github/ISSUE_TEMPLATE/missing_service_call.md deleted file mode 100644 index d221add8..00000000 --- a/.github/ISSUE_TEMPLATE/missing_service_call.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Missing Service Call -about: Service call is missing in Ryujinx. -#assignees: ---- - -## Missing Service Call - -[ If any section does not apply, replace its contents with "N/A". ]
-[ If you do not have the information needed for a section, replace its contents with "Unknown". ]
-[ Lines between [ ] (square brackets) are to be removed before posting. ] - -[ Please search for existing [missing service call](https://github.com/Ryujinx/Ryujinx/issues) before you make your own issue. ]
-[ See the following [issue](https://github.com/Ryujinx/Ryujinx/issues/1431) as an example ]
-[ Duplicate issue will be marked as such and you will be referred to the original request. ] - -### What service call is missing? - -*SERVICE* *INTERFACE*: *NUMBER* (*NAME*) is not implemented.
-[ Replace *SERVICE* by the service name, e.g. appletAE ]
-[ Replace *INTERFACE* by the interface name, e.g. IAllSystemAppletProxiesService ]
-[ Replace *NUMBER* by the call number, e.g. 100 ]
-[ Replace *NAME* by the call name, e.g. OpenSystemAppletProxy ]
-[ e.g. appletAE IAllSystemAppletProxiesService: 100 (OpenSystemAppletProxy) ] - -[ Add related links to the specific call from [Switchbrew](https://switchbrew.org/w/index.php?title=Services_API) and/or [SwIPC](https://reswitched.github.io/SwIPC/) ] - -### Service description -``` -* -``` -[ Include the description/explanation from [Switchbrew](https://switchbrew.org/w/index.php?title=Services_API) and/or [SwIPC](https://reswitched.github.io/SwIPC/) in the above code block ] - -### Required by: -[ Add our (games list database)[https://github.com/Ryujinx/Ryujinx-Games-List/issues] links of games who require this call ] diff --git a/.github/ISSUE_TEMPLATE/missing_service_call.yml b/.github/ISSUE_TEMPLATE/missing_service_call.yml new file mode 100644 index 00000000..72a52117 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/missing_service_call.yml @@ -0,0 +1,31 @@ +name: Missing Service Call +description: Service call is missing in Ryujinx. +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search for an [existing missing service call issue](https://github.com/Ryujinx/Ryujinx/issues) first. + options: + - label: I have searched the existing issues + required: true + - type: textarea + id: instruction + attributes: + label: Service Call + description: What service call is missing? + validations: + required: true + - type: textarea + id: name + attributes: + label: Service description + description: Include the description/explanation from [Switchbrew](https://switchbrew.org/w/index.php?title=Services_API) and/or [SwIPC](https://reswitched.github.io/SwIPC/) in the above code block + validations: + required: true + - type: textarea + id: required + attributes: + label: Required by + description: Add links to the [compatibility list page(s)](https://github.com/Ryujinx/Ryujinx-Games-List/issues) of the game(s) that require this service. + validations: + required: true \ No newline at end of file