Use issue templates for `python/cpython`

[ezio-melotti]

After the migration, we could use issue templates on the python/cpython repo.

When the user clicks on the green "New Issue" button, we could present a few options (like this repo does):

• Propose a new feature or enhancement
• Report a bug
• Report a crash
• Report a security issue
• Visit the documentation

The first four provide a first level of triaging, by determining the type of issue. The last two can be links to the security policy page (or something equivalent) and a Devguide section about reporting bugs. Each of them should have a description to clarify when to use them. An additional link to python-ideas could be added too.

It is also possible to create templates that use forms, with dropdowns and textareas that can be filled by the user.

If we do this, we could have a few dropdowns for

• The affected area: library/tests/documentation/interpreter-core/extension-modules/not-sure
• Python version: 3.7/3.8/3.9/3.10/3.11, possibly also options for branches in security/bug fixes/features mode
• Operating system: all/Linux/MacOS/Windows/others

A few other considerations:

• We could have a single template, with the "issue type" selection being another dropdown
• We could disable free-form issues and enforce the use of templates
• We should make clear that the version/os refer to the ones where the behavior has been observed by the user, and not necessarily all the affected targets
• We should be able to automatically set some labels depending on the selections made by the user
• We could also make the form simpler (or avoid using it altogether) and skip the dropdowns, making reporting easier and triaging more difficult (but possibly more accurate)

I still have to play around more with issue templates to better understand the extent of their capabilities, and I'm open to more ideas and feedback, especially from people that have related experience on other repos.

[ezio-melotti]

If we start using templates, we should also include a link to python-ideas among the options. I already saw a few reports proposing ideas (e.g. python/cpython#91509 and python/cpython#91540).

[AlexWaygood]

I'd support issue templates, and I think we should implement them with some urgency. There's been a particularly large increase in issues proposing radical syntax changes, as well as issues from beginners seeking user help. As well as the ones you've already pointed out, there's also been:

• @staticmethod called as regular function (= outside the class scope?) cpython#91473
• Syntax for aliases to keys of python dictionaries cpython#91440
• pprint output could be more organised cpython#91460

The fact that filers of issues can't (without issue templates) add their own labels (like they could on BPO) also increases the triaging burden for each new issue.

[hugovk]

@AlexWaygood re: urgency, would you like to PR up some basic templates?

We could merge that sooner to help steer people in the right direction.

And then iterate to get all the neat dropdowns and so on in Ezio's post.

[AlexWaygood]

@AlexWaygood re: urgency, would you like to PR up some basic templates?

We could merge that sooner to help steer people in the right direction.

And then iterate to get all the neat dropdowns and so on in Ezio's post.

Yup, sounds good — I'll try to send a PR today!

[AlexWaygood]

• Add minimal issue templates cpython#91569

[ezio-melotti]

The template added by @AlexWaygood in python/cpython#91569 seems to be working well, so I think this can be closed. Should the need arise to improve upon what we have, a new issue can be opened.