Add minimal issue templates by AlexWaygood · Pull Request #91569 · python/cpython · GitHub

A first step towards:

Use issue templates for python/cpython core-workflow#437

These are largely derived from the mypy issue templates, which I think are pretty effective (more effective than what CPython has currently, anyway 🙂)

(It's the first time I've tried setting up issue templates, so please review carefully.)

Looks good!

To compare with Mypy, will be something like: https://github.com/python/mypy/issues/new/choose

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

One last thing.

We can also skip "please" for brevity.

The Google style guide is pretty good, and says:

https://developers.google.com/style/tone?hl=en#politeness-and-use-of-please

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Thank you!

Looks mostly good to me, at least as a first iteration.

A few comments:

I'm not a big fan of templates with a lot of text and comments, even though I guess they might be more useful for people that are reporting issues for the first time
If we automatically add labels, it will be more difficult to distinguish triaged and untriaged issues (that currently have no labels) -- do we need to automatically an untriaged or new label for all new issues and remove it once a triager checks them?
We could disable free-form issues, but core-devs might want to use them

Nice!

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

It looks like there are 179 open issues that have the "build" label, but don't have any of "type-bug", "docs", "type-security" or "type-feature".

I think I'd rather not create a build.md template, as I think if we have too many options it will just complicate things unnecessarily -- but I thought I'd mention it.

I'm not a big fan of templates with a lot of text and comments

Neither am I, tbh, but as you say -- they're not really for us; they're for people who are new to CPython :)

If we automatically add labels, it will be more difficult to distinguish triaged and untriaged issues (that currently have no labels) -- do we need to automatically an untriaged or new label for all new issues and remove it once a triager checks them?

We could do that -- I've seen other projects do that. I don't think that's essential, though. CPython has a fairly active group of triagers and core devs who will generally be sifting through recently opened issues anyway. Most of the time, invalidly applied labels will be spotted fairly quickly; and if not, I don't think it's that big a deal anyway.

A couple more nits and then it's good to go:

I tried to clarify when to use the "crash" template
I included "enhancements" in the "feature" template

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Thanks everybody for the reviews!

Thanks for the PR!

It looks like we have 3 security-related entries now: https://github.com/python/cpython/issues/new/choose
I suspect the one with the green "View policy" button is added automatically, probably because we have a .github/SECURITY.md file. I think we can just remove the link from the config.yml.

It might actually be better to remove the .github/ISSUE_TEMPLATE/security.md file too, and just leave the default security entry. What do you think?

It might actually be better to remove the .github/ISSUE_TEMPLATE/security.md file too, and just leave the default security entry. What do you think?

Yup, I think that's best! I had no idea having the .github/SECURITY.md would mean we'd have the duplicate entries. One is enough.

It might actually be better to remove the .github/ISSUE_TEMPLATE/security.md file too, and just leave the default security entry. What do you think?

Yup, I think that's best! I had no idea having the .github/SECURITY.md would mean we'd have the duplicate entries. One is enough.

Issue templates: Remove duplicate links to security policy #91590

It looks like their are 179 open issues that have the "build" label, but don't have any of "type-bug", "docs", "type-security" or "type-feature".

This is because "build" used to be a type on bpo, and now it's a label on its own, since you can have both build-related features and bugs.

Add minimal issue templates

16d59f5

bedevere-bot added the awaiting review label Apr 15, 2022

AlexWaygood added skip issue skip news labels Apr 15, 2022

AlexWaygood requested review from ezio-melotti and hugovk April 15, 2022 14:37

AlexWaygood mentioned this pull request Apr 15, 2022

Use issue templates for python/cpython python/core-workflow#437

Closed

Wording tweaks

de9ed90

hugovk reviewed Apr 15, 2022

View reviewed changes

AlexWaygood and others added 4 commits April 15, 2022 18:12

Apply suggestions from code review

483632e

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Improve words in security template

5afdd72

Update bug.md

b289c49

Update crash.md

d4eccad

AlexWaygood requested a review from hugovk April 15, 2022 17:19

AlexWaygood added 2 commits April 15, 2022 18:24

Add link to security vulnerability website from first page

0664d48

Never edit on your phone

22ef781

hugovk reviewed Apr 15, 2022

View reviewed changes

AlexWaygood and others added 3 commits April 15, 2022 18:39

Apply suggestions from code review

a9aea8f

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Update .github/ISSUE_TEMPLATE/config.yml

fa7da16

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Apply suggestions from code review

246ea0a

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

AlexWaygood requested a review from hugovk April 15, 2022 17:48

hugovk approved these changes Apr 15, 2022

View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels Apr 15, 2022

ezio-melotti reviewed Apr 15, 2022

View reviewed changes

Comment thread .github/ISSUE_TEMPLATE/crash.md Outdated

Comment thread .github/ISSUE_TEMPLATE/config.yml Outdated

Comment thread .github/ISSUE_TEMPLATE/config.yml Outdated

Comment thread .github/ISSUE_TEMPLATE/config.yml

Comment thread .github/ISSUE_TEMPLATE/config.yml

erlend-aasland reviewed Apr 15, 2022

View reviewed changes

Comment thread .github/ISSUE_TEMPLATE/security.md Outdated

Comment thread .github/ISSUE_TEMPLATE/bug.md Outdated

Comment thread .github/ISSUE_TEMPLATE/bug.md Outdated

AlexWaygood and others added 3 commits April 15, 2022 20:15

Apply suggestions from code review

2a50b24

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>

There might not be a traceback if there's a crash

642bc82

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Update .github/ISSUE_TEMPLATE/config.yml

4f11634

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

AlexWaygood added 2 commits April 15, 2022 20:18

Reorder config.yml file

1834c5c

Fix Erlend's nits

9c96ec7

erlend-aasland approved these changes Apr 15, 2022

View reviewed changes

version -> architecture

6afef34

AlexWaygood requested a review from ezio-melotti April 15, 2022 20:16

ezio-melotti reviewed Apr 16, 2022

View reviewed changes

Apply suggestions from code review

534c607

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

AlexWaygood requested a review from ezio-melotti April 16, 2022 00:44

ezio-melotti approved these changes Apr 16, 2022

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting core review labels Apr 16, 2022

ezio-melotti merged commit 1169b0b into python:main Apr 16, 2022

bedevere-bot removed the awaiting merge label Apr 16, 2022

ezio-melotti self-assigned this Apr 16, 2022

AlexWaygood deleted the issue-templates branch April 16, 2022 01:21

AlexWaygood mentioned this pull request Apr 16, 2022

Issue templates: Remove duplicate links to security policy #91590

Merged

hugovk mentioned this pull request Apr 16, 2022

Add issue template to avoid useless issues python/peps#2492

Closed

Add minimal issue templates by AlexWaygood · Pull Request #91569 · python/cpython · GitHub

Repository navigation

Add minimal issue templates - #91569

Add minimal issue templates#91569ezio-melotti merged 18 commits intopython:mainpython/cpython:mainfrom AlexWaygood:issue-templatesAlexWaygood/cpython:issue-templatesCopy head branch name to clipboard

Conversation

AlexWaygood commented Apr 15, 2022

Uh oh!

AlexWaygood commented Apr 15, 2022

Uh oh!

hugovk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hugovk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hugovk left a comment

Choose a reason for hiding this comment

Uh oh!

ezio-melotti left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

erlend-aasland left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AlexWaygood commented Apr 15, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AlexWaygood commented Apr 15, 2022

Uh oh!

ezio-melotti left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AlexWaygood commented Apr 16, 2022

Uh oh!

ezio-melotti commented Apr 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ezio-melotti commented Apr 16, 2022

Uh oh!

AlexWaygood commented Apr 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AlexWaygood commented Apr 16, 2022

Uh oh!

ezio-melotti commented Apr 16, 2022

Uh oh!

Reviewers

Add minimal issue templates#91569
ezio-melotti merged 18 commits into
python:mainfrom
AlexWaygood:issue-templates

AlexWaygood commented Apr 15, 2022 •
edited
Loading

ezio-melotti commented Apr 16, 2022 •
edited
Loading

AlexWaygood commented Apr 16, 2022 •
edited
Loading