search

Foohy / jazztronauts

Jazztronauts is a cooperative theft-em-up for Garry's Mod, also known as prop hunt 2.
122 stars 35 forks source link

Add issue templates #186

Closed Commenter25 closed 6 months ago

Commenter25 commented 1 year ago

This is a relatively new feature of GitHub which massively reduces issues with insufficient information. Rather than hoping users provide helpful information, or using the classic issue template system which was plain text that could simply be deleted, this presents the questions in a real form with proper UI elements.

Here, I've added 3 templates. All of them end with a standard text area which can be filled out the exact same way as a traditional issue. They also discourage title tagging, like [BUG] or [FEATURE], since the issues are automatically tagged.

  1. Bug reports, the most thorough template, which asks for detailed information about the user's setup and possible variables for reproducing the bug. It also assigns the issue the bug tag automatically.
  2. Feature requests, much simpler and closer to just leaving a traditional issue, but it also adds the enhancement tag automatically.
  3. Essentially just a traditional issue. The reason for this is that normally, GitHub shows the blank issue button like a footnote, away from all the big buttons for templates. I personally believe it's cleaner UX to disable that footnote and have another template consistent with the others.

You can read about this feature here, and you can tinker with the system on my fork where it's activated, and you can see an example issue made with this system.

(note, the templates on my fork i linked above is now slightly out of date since it's only the first commit, but you can still get a feel for it)