search

Atmosphere-NX / Atmosphere

Atmosphère is a work-in-progress customized firmware for the Nintendo Switch.
GNU General Public License v2.0
15.12k stars 1.25k forks source link

Template test #1849

Closed beyondmeat closed 2 years ago

beyondmeat commented 2 years ago

Bug Report

[ If any section does not apply, replace its contents with "N/A". ]
[ Lines between [ ] (square brackets) should be removed before posting. ]

[ * ]
[ Note: If the bug or crash you encountered is related to; ]
[ - software used to make "backups", ]
[ - software explicitly distributed for piracy, etc ]
[ then contributors will not provide support for your issue and your issue will be closed. ]

What's the issue you encountered?

[ Describe the issue in detail and what you were doing beforehand. ]
[ Did you make any changes related to Atmosphère 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. ]

Crash Report

[ Crash reports can be found under /atmosphere/crash_reports. ]
[ If your issue caused Atmosphère to crash, include the crash report(s) by creating a gist and pasting the link here. ]
[ If you don't include a crash report in instances of crash related issues, we will ask you one to provide one. ]

System Firmware Version

X.X.X
[ Replace X's with system firmware version at time of crash. ]
[ You can find your firmware version in the Settings -> System, under "System Update". ]
[ If it says "Update Pending", you can clear the pending update by rebooting to Maintenance Mode. ]

Environment?

Additional context?

beyondmeat commented 2 years ago

@SciresM you should switch the help info to md comments (html like syntax) then they don't appear when you submit a PR

SciresM commented 2 years ago

@beyondmeat what?

I don't understand why you made a an empty template issue. It seems a little rude/time wasting to do so without messaging me on discord ahead of time.

beyondmeat commented 2 years ago

@SciresM all the template help text you have between the square brackets should be changed so they are markdown comments instead. That way none of that help text that clutters up the template is visible (remains visible in edit mode). This will make the issues more readable while achieving the same thing. The result is a cleaner filled out template.

For extra clarification: I'm talking about the template help like [ If using an EmuMMC, include whether it's partition-based or file-based. ] if you change that to be a comment, when the issue is submitted the comments are not visible. This is actually a common practice when using the template feature.

So what that will do is make that help info visible in edit mode, but not when viewing. Resulting in a more readable issue for you.

Not everyone is on discord and I'm sorry you found this rude. I just noticed a lot of people aren't filling out your templates and that got me looking at them.

beyondmeat commented 2 years ago

Also the biggest reason is so users no longer need to remove the lines before positing @SciresM.. switching the brackets to a comment will have the same effect.

SciresM commented 2 years ago

@beyondmeat the whole point of the template is to make the user go through the process of editing it all.

Lazy users who submit issues without fully replacing all the text will have their issues closed and be told to reopen with the template filled out.

The way it works out maximizes my ability to tell when someone hasn't filled it out quickly, which saves time and energy.

I do not believe that what you describe will result in filled out templates. I believe it will result in less complete templates.

It will eventually be replaced by the GitHub forms which make filling out the fields actually required, but that's a low priority TODO item.

For what it's worth, development happens on discord. If you're interested, message SciresM#0524 -- an issue like this without a message to me is just confusing.

My intent would have been for you to click the "question" template which tells you to use discord.