Cubyz icon indicating copy to clipboard operation
Cubyz copied to clipboard

Make issue templates

Open IntegratedQuantum opened this issue 7 months ago • 5 comments

What kinds of issue templates do we need?

  • [x] Bug
  • [x] Proposal (should contain a link to the game design principles)
  • [x] ~~Question (should link to "FAQ")~~

IntegratedQuantum avatar Jun 16 '25 15:06 IntegratedQuantum

Question template that links to a FAQ?

ikabod-kee avatar Jun 16 '25 15:06 ikabod-kee

FAQ in this case I guess would be a link to issues with the question label :​P

IntegratedQuantum avatar Jun 16 '25 15:06 IntegratedQuantum

Actually, I don't really want to encourage people to ask questions here on github. This isn't really the right place in my opinion.

IntegratedQuantum avatar Jun 16 '25 17:06 IntegratedQuantum

You could differentiate between different bug types. Instead of having single bug category, you can have "crash", "graphical bug", "physics bug" etc. or whatever categories you think fit. There are two reasons, firstly to avoid complicated explanations inside the template with lots of alternatives, secondly to allow users to do more categorization work for you. I would advise to include checklists for basic stuff like "I searched issues" "I red guidelines" so that check list remains a part of the issue. For some of the bug types you would really want to get expected behavior and screenshots of whats wrong, for others it doesn't really make that much sense (eg. for crash)

Argmaster avatar Jun 16 '25 18:06 Argmaster

I would advise to include checklists for basic stuff like "I searched issues" "I red guidelines" so that check list remains a part of the issue.

Yeah, I'm also not too happy with how the link is rendered. I think I'll have to take a look into issue template forms.

IntegratedQuantum avatar Jun 17 '25 16:06 IntegratedQuantum

Something like could also be interesting to allow people to label it https://github.com/marketplace/actions/advanced-issue-labeler, e.g. we could make a list of checkboxes for each label.

IntegratedQuantum avatar Jun 18 '25 13:06 IntegratedQuantum

Anyways, I think it's good enough for now.

IntegratedQuantum avatar Jun 18 '25 14:06 IntegratedQuantum