search

ValveSoftware / Source-1-Games

Source 1 based games such as TF2 and Counter-Strike: Source
646 stars 74 forks source link

[github meta] Add issue templates #5781

Open CosminPerRam opened 6 months ago

CosminPerRam commented 6 months ago

About

Github has issue templates, by their name, are customizable templates that users can use (or should, just as a suggested thing) when making an issue or even for pull requests.

Why?

Seeing the recent issues wave because of the Tf2 64-bit update, this could greatly help people to make a readable, insightful and consistent report, as a lot of them are just one-liners and are not that helpful.

Although the requirements for a well-written issue are already in the readme this imposes the rules a lot more.

Multiple templates can be done and they support things such as dropdowns and checkboxes.

If there is interest into adding this I could make some template suggestions that I think fits around here, would be glad to hear some thoughts about this as I think the repository could benefit a lot for this.

CosminPerRam commented 6 months ago

Providing more context about some examples: To see some realistic examples, over at facepunch/sbox-issues they do have some templates: image An example of the bug report one: image

CosminPerRam commented 6 months ago

Even more: you can also set labels for each issue, so users dont have to include these in the title (such as [TF2], [BUG], [LINUX], [SUGGESTION] and so on).

ArtKitCat commented 6 months ago

yeah i have to agree on this, there's over 3000+ issues currently and some dating as far back as 2012. There's no way over 3k issues are being kept up to date and actively worked on.

TheBoctor commented 6 months ago

This would help a lot, especially with the tracker being linked in the patch notes for the 64-bit branch's mainlining. It seems like a lot of new users are now coming here to report client crashes, but many are also new to trackers, and so they may forget to include OS/machine details, let alone logs or dumps.

CosminPerRam commented 6 months ago

@kisak-valve hey, hope you don't mind the ping, any thoughts on this coming from an official standpoint? seems like many agree on adding this.