Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

infra: updated github issue templates #1972

Merged
merged 13 commits into from
Dec 29, 2024

Conversation

vladmikhalin
Copy link
Collaborator

These issue templates were stolen borrowed as best practices from PCSX2 and modified according to our needs.

@Hermiten
Copy link
Collaborator

The link for the forum is useless , I will check the rest in an hour :)

@GHU7924
Copy link

GHU7924 commented Dec 29, 2024

If you need help using the emulator please make a request on our forums or contact us on discord.
If you are unsure, start with discord or the forums.
Please make an effort to make sure your issue isn't already reported.
Do not create issues involving software piracy, our rules specifically prohibit this and your issue will be closed and you will be banned in this repository.

This information should also be included in Quickstart.md
Maybe something else.

This is where regular users come in, who are getting to know GitHub for the first time and don't know all the details. I think it's time to add all the information regarding the issues (that they should be technical or aimed at improvement), regarding modules, system requirements, problems of other forks, and so on. I mean, it's time to make an emulator welcome window. Perhaps this step will help to avoid the same type of problems that have to be distracted.

@tomboylover93
Copy link
Contributor

I also think we should make an emulator welcome window. This could serve as a barrier of entry for people who pirate things as we could tell the user to put the system modules in sys_modules and scan for them (similar to what PCSX2 does) before continuing.

But most importantly this information should be upfront on the README.md for this repo. Or maybe on https://shadps4.net as the first thing you see there are blog posts.

@Hermiten
Copy link
Collaborator

Hermiten commented Dec 29, 2024

For "Application bug report" -> I thing the log is not needed
For "Game emulation bug report" -> Can you also give the link of the compatibility repo: https://github.com/shadps4-emu/shadps4-game-compatibility and specify to check if the game is present here

For config.yml, replace it by:

blank_issues_enabled: false
contact_links:
  - name: Discord
    url: https://discord.gg/bFJxfftGW6
    about: Get direct support and hang out with us
   - name: Wiki
    url: https://github.com/shadps4-emu/shadPS4/wiki
    about: More informations, guides, etc... 

We are working on the wiki, we plan to have an initial release today

@vladmikhalin
Copy link
Collaborator Author

Addressed the review comments.

Quickstart.md and Welcome Window are out of scope of this PR.

@Hermiten
Copy link
Collaborator

Seem's good for me

@GHU7924
Copy link

GHU7924 commented Dec 29, 2024

Is there an option to attach a screenshot or video everywhere?

Also, game-bug-report.yaml - Checklist

I think it's worth adding an item about modules, sys and sce. https://github.com/shadps4-emu/shadps4-game-compatibility?tab=readme-ov-file#informations
It might also have been worth leaving (add the RAM item).

@vladmikhalin
Copy link
Collaborator Author

Is there an option to attach a screenshot or video everywhere?

Also, game-bug-report.yaml - Checklist

I think it's worth adding an item about modules, sys and sce. https://github.com/shadps4-emu/shadps4-game-compatibility?tab=readme-ov-file#informations It might also have been worth leaving (add the RAM item).

Any screenshot can be attached to description or reproduction steps.

@vladmikhalin
Copy link
Collaborator Author

I think I've addressed all comments, please confirm.

@GHU7924
Copy link

GHU7924 commented Dec 29, 2024

Please make an effort to make sure your issue isn't already reported.

It may also be worth adding here that there may be a "Pull requests" that is already aimed at eliminating this problem.

@vladmikhalin
Copy link
Collaborator Author

vladmikhalin commented Dec 29, 2024

Please make an effort to make sure your issue isn't already reported.

It may also be worth adding here that there may be a "Pull requests" that is already aimed at eliminating this problem.

I think it's too much to ask from a user. Most PRs are very technical in their description and do not state all the games they are fixing. Also I think it is fine to have an issue that will be closed by a WIP PR.

@GHU7924
Copy link

GHU7924 commented Dec 29, 2024

I think it's too much to ask from a user. Most PRs are very technical in their description and do not state all the games they are fixing. Also I think it is fine to have an issue that will be closed by a WIP PR.

Maybe you're right.

At the moment, I don't see any problems, it seems that all the necessary information is present. But if anything, it will always be possible to correct or supplement it in the future. Good job.

@Hermiten
Copy link
Collaborator

Let's go !

@ngoquang2708
Copy link
Contributor

Don't forget reuse ci check :D

Copy link
Collaborator

@polybiusproxy polybiusproxy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One last thing. For logs we should ask for the log type to be set as 'sync' to avoid cut-off logs.

@vladmikhalin vladmikhalin merged commit e709a8c into shadps4-emu:main Dec 29, 2024
9 checks passed
@vladmikhalin vladmikhalin deleted the issue-templates branch December 29, 2024 20:09
@Hermiten
Copy link
Collaborator

One last thing. For logs we should ask for the log type to be set as 'sync' to avoid cut-off logs.

Can be an idea to put sync by default ?

@GHU7924
Copy link

GHU7924 commented Dec 29, 2024

Can be an idea to put sync by default ?

In my personal opinion, I don't think this is necessary.

It will be possible to make some changes to the interface if the task is to collect data, but this is no longer relevant for this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants