Skip to content
This repository has been archived by the owner on Aug 26, 2021. It is now read-only.

GitHub Issue Templates #195

Closed
Nerdpie opened this issue Apr 4, 2019 · 3 comments
Closed

GitHub Issue Templates #195

Nerdpie opened this issue Apr 4, 2019 · 3 comments
Labels

Comments

@Nerdpie
Copy link
Contributor

Nerdpie commented Apr 4, 2019

Although Plethora doesn't have too many issues in the tracker, it may be beneficial to set up issue templates. These templates from CyclopsMC's CommonCapabilities may be a good starting point.

Plethora might benefit from a template specifically for mod support. I don't know off hand how difficult it would be, but we could configure the Mod integration project to automatically track issues made with such a template, as well as reminding users to check said project first.

I will gladly draft templates and open a PR, but I would like feedback on:

  • How useful would templates be for Plethora?
  • What templates would we want?
  • Do we want any particular details in the templates, such as thanking users for their interest, or requesting that logs be included via Pastebin/Gist/etc. ?
@SquidDev SquidDev added the meta label Apr 4, 2019
@SquidDev
Copy link
Member

Just as a bit of reference, this is what I currently use for CC: Tweaked. Worth mentioning there's some comments there, so make sure to view the raw source.

We could probably do something similar for Plethora. It might be good to make them friendlier, though also want to avoid adding too many words as it may be overwhelming...

It may also be good to have a specific "mod integration" issue, asking people to give detailed use-cases, maybe code samples in some cases, etc... Basically avoiding issues like #160. However, issues like #185 don't really need lots of details, so I'm not too sure.

@Nerdpie
Copy link
Contributor Author

Nerdpie commented Apr 24, 2019

I've copied the templates from CC:T, and made some minor tweaks. For one, I have the templates automatically applying labels, though that may be open to abuse. That said, I don't want to create a template for each of the labels that make sense for new issues1, as that would be a bit overwhelming for users, and we would want a generic template that isn't tied to a label, just in case.

1: It wouldn't make sense for new issues to automatically have labels such as 'duplicate', 'PRs welcome', etc.

@SquidDev
Copy link
Member

Added in #209. Many 💕 to @Nerdpie for putting those together!

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

No branches or pull requests

2 participants