Use pip's Issue Template design to guide users towards the right forum

[matthewfeickert]

Description

TIL that pip has a super nice Issue template page

that uses a .github/ISSUE_TEMPLATE/config.yml file to add the ability to have additional buttons (here Discourse and IRC) to guide user's reporting.

This seems like a great idea that we should encorperate as well. It would seem to also be useful for basically all of the Scikit-HEP projects, especially those with Gitter channels. cc @eduardo-rodrigues @jpivarski @henryiii

[matthewfeickert]

The GitHub Docs for the "template chooser" are here: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser

[matthewfeickert]

Also to the surprise of no one, this was added in to pip by our helpful friend @webknjaz. :) pypa/pip#7630

[jpivarski]

I agree:

[henryiii]

Hist (mostly courtesy of @LovelyBuggies):

boost-histogram:

[matthewfeickert]

@jpivarski @henryiii 🤣 Seems I'm behind the curve. Great that you're already both doing this! :)

[webknjaz]

You may also be interested in issue forms as demoed here https://github.com/ansible/ansible/issues/new/choose (needs a feature flag tho).

P.S. You know that you can have an org-wide fallback in special repo ORG/.github, right?

[henryiii]

Oooh, now that I didn't know. What sorts of things can go in it? Does it just get merged with the .github folder? Can't easily find examples of one.

[webknjaz]

Dirs are merged but not files, if a file exists in the repo, it's fallback is not used.

[henryiii]

That's about what I'd expect. So I could add dependabot for everybody... 😈

We could provide a default "gitter" issue, maybe a default contributing, etc. It could even be a way to provide a default labeling bot via an action, perhaps?

[webknjaz]

The support for non-gh-builtin things varies per GH App / bot tho. So it'll not always work.

[matthewfeickert]

c.f. scikit-hep/awkward#987 by @agoose77 for example of using YAML to create forms. 0_0! 🚀

The GitHub docs are here: Syntax for issue forms

[webknjaz]

@matthewfeickert not sure if you saw but FYI also check out how Pradyun attempts to direct people to discussions while only allowing bug creation after that: https://github.com/pradyunsg/furo/issues/new/choose.

[matthewfeickert]

not sure if you saw but FYI also check out how Pradyun attempts to direct people to discussions while only allowing bug creation after that: https://github.com/pradyunsg/furo/issues/new/choose.

This is pretty clever! I'll have to look more at how this is being used.