ShuriZma
/
project64
mirror of https://github.com/project64/project64.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Some repo improvements and small fixes (#2207) 

* Enforce a standard issue template

This will enforce a standard issue template, and will force the user to make sure they are creating the issue with all of the info the developers and contributors need to help the user.

Also updates the README to be less confusing and also a bit more broad in some cases.

* Update the issue template for bugs

* Add a checkbox for default plugins

* Add input plugins to the list

* Add a reminder in the CONTRIBUTING file

* Add a small improvement to the README

* Update BUG.yml with some formatting and text improvements

* Switch to YAML for the feature request template as well

* Remove old Markdown templates

* Fix placeholder on line 30

* Fix assignees

* Fix assignees part 2

* Fix assignees part 3

* Fix spacing

* Finally fix formatting (YAML is picky)

* Fix it part 11 thousand or something

* Finally fixed maybe sort of kinda

* Update BUG.yml

* Fixed some weirdness

* Fix required maybe

* Finally fixed perhaps?
This commit is contained in:
Derek "Turtle" Roe 2022-03-09 00:41:57 -06:00 committed by GitHub
parent fd353de5d7
commit 962de3e29c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 139 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/CONTRIBUTING.md vendored
View File

@ -7,3 +7,5 @@ Following these guidelines will help make sure that users and developers alike c
Project64 is an open-source project and we love to receive contributions from the community. There are many ways to contribute, from writing and improving the documentation, testing, submitting bug reports and feature requests, or writing code which can be incorporated into Project64 itself.
Please don't use the issue tracker for support questions. Please join the Discord so the community can help with your issue!
Please do NOT post any copyrighted materials.

165
.github/ISSUE_TEMPLATE/BUG.yml vendored
View File

@ -1,114 +1,145 @@
name: Bug Report
description: If you experience a bug in the Emulator and its default plugins, please open an issue here and fill out the template.
title: "[Bug]: "
labels: ["bug", "triage"]
assignees:
-
name: Bug report
description: >-
If you experience a bug in Project64 and its default plugins, please open an
issue here and fill out the template.
title: '[Bug]: '
labels:
- bug
- triage
assignees:
- null
body:
- type: markdown
attributes:
value: "## FAQ's and a warning"
attributes:
value: '## FAQs and a warning'
- type: markdown
attributes:
value: |
If you are having issues with a plugin that isn't included with and supported by the Project64 team, we cannot support you other then pointing you to the developer of those plugins.
Please join the Discord first and ask questions and ask for support there first. If the issue should require an open GitHub issue, somebody will ask you to open one. We have a lot of people in the Discord who are more then happy to help you with any issues you may be having!
Please avoid opening issues if you do not meet the minimum requirements for Project64. These are outlined in the README for this repository.
attributes:
value: >-
If you are having issues with a plugin that isn't included with and
supported by the Project64 team, we cannot support you other then pointing
you to the developer or repository for those plugins.
Please join the Discord first and ask questions and ask for support there
first. If the issue should require an open GitHub issue, somebody will ask
you to open one.
We have a lot of people in the Discord who are more then
happy to help you with any issues you may be having!
Please avoid opening issues if you do not meet the minimum requirements
for Project64. These are outlined in the README for this repository.
- type: textarea
id: what-should-happen
attributes:
attributes:
label: Expected behavior?
description: How was the emulator supposed to behave
placeholder: Tell us what you expect to see!; use screenshots if necessary.
value:
validations:
value: null
validations:
required: true
- type: textarea
id: what-happened
attributes:
attributes:
label: Actual behavior?
description: Describe the issue you encountered.
placeholder: Tell us what you see!; use screenshots if necessary.
value:
validations:
value: null
validations:
required: true
- type: textarea
id: repro
attributes:
attributes:
label: Steps to reproduce the problem
description: "How do you trigger this bug? Please walk us through it step by step."
description: How do you trigger this bug? Please walk us through it step by step.
value: |
1.
2.
3.
4.
5.
...
validations:
1.
2.
3.
4.
5.
...
validations:
required: true
- type: textarea
id: error-messages
attributes:
attributes:
label: Error messages?
description: Was there an error message?
placeholder: List any exception messages here!; use screenshots if necessary.
value:
validations:
placeholder: List any error messages here!; use screenshots if necessary.
value: null
validations:
required: false
- type: textarea
id: Rom_Details
attributes:
label: What game were you playing
description: "What is the specific rom that you encountered an issue with"
id: ROM_details
attributes:
label: What game were you playing?
description: What is the specific ROM that you encountered an issue with?
value: |
Title:
N64 or 64DD:
ROM CODE: (File > ROM Info, or Context Menu > Rom Information in the ROM List)
SAVE TYPE: (Attach MPK, Battery or Savestate here)
Clean or Hacked?:(Attach Patch here)
validations:
Title:
Nintendo 64 game or Nintendo 64 Disk Drive:
ROM information: (File > ROM info, or context menu > ROM information in the ROM
list)
Save type: (Attach game save or save state here)
Original or modified ROM?:(attach patch here)
validations:
required: false
- type: textarea
id: SysInfo
attributes:
label: Specifications and Build details
description: "List your system information, you can obtain this from MSINFO32 and the emulators Titlebar."
attributes:
label: Specifications and build details
description: >-
List your system information, you can obtain this from MSINFO32 and the
emulators title bar and about page.
value: |
Project64: (include commit version number and whether you are using the 32-bit or 64-bit version)
OS: (include version and OS build number using WinVer):
CPU:
GPU:
RAM:
validations:
Project64: (include commit version number and whether you are using the
32-bit or 64-bit version)
OS: (include version and OS build number using WinVer):
CPU:
RAM:
Graphics:
validations:
required: true
- type: checkboxes
id: DefaultPlugins
attributes:
label: Using included Plugins
description: Please make sure you are using the included plugins before opening an issue
attributes:
label: Using included plugins
description: >-
Please make sure you are using the included plugins before opening an
issue:
options:
- label: I can confirm I am using the included RSP, audio, input, and graphics plugins
- label: >-
I can confirm I am using the included RSP, audio, input, and graphics
plugins
required: true
- type: textarea
id: PluginsUsed
attributes:
attributes:
label: Plugins used while the issue occurred
description: "What plugins is the issue occuring with"
description: What plugins is the issue occuring with?
value: |
Graphics plugin (and HLE or LLE):
Audio plugin:
Input plugin:
RSP plugin:
validations:
Graphics plugin (and HLE or LLE):
Audio plugin:
Input plugin:
RSP plugin:
validations:
required: true
- type: checkboxes
id: Copyright_Compliance
attributes:
attributes:
label: Copyright Compliance
description: Please do not attach any files that infringe on the copyright of Nintendo or its partners, this in
description: >-
Please do not attach any files that infringe on the copyright of any
party.
options:
- label: There are no infringing files attached to this bug report.
required: true
required: true

19
.github/ISSUE_TEMPLATE/FEATURE.md vendored
View File

@ -1,19 +0,0 @@
---
name: Feature request
about: Create a Feature request to suggest improvements and additions.
title: "[Feature request]: "
labels: "enhancement"
assignees: ''
---
### Please include [Feature request] at the beginning of the title
### Feature desired:
-
### Why this feature should be added:
-
### Examples of it being successfully implemented in other software:
-

38
.github/ISSUE_TEMPLATE/FEATURE.yml vendored Normal file
View File

@ -0,0 +1,38 @@
name: Feature request
description: >-
If you would like a new feature in Project64 or its default plugins, please
open an issue here and fill out the template.
title: '[Feature request]: '
labels:
- feature request
- enhancement
assignees:
- null
body:
- type: textarea
id: feature-request
attributes:
label: Request box
description: What feature would you like to see added?
placeholder: Tell us what you would like to see added to Project64!
value: null
validations:
required: true
- type: textarea
id: reason-why
attributes:
label: Reason box
description: Provide reasoning for the new feature
placeholder: Tell us why you'd like to see this feature added
value: null
validations:
required: true
- type: textarea
id: Examples
attributes:
label: Examples
description: Provide examples of this feature
placeholder: Provide examples or screenshots of this feature in other software
value: null
validations:
required: true

2
README.md
View File

@ -35,7 +35,7 @@ AppVeyor (Windows x86/x64): [![Build status](https://ci.appveyor.com/api/project
### Compiling
```
Visual Studio Community
Visual Studio Community 2015 or later
```
Load .sln project file and compile.