Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add minimal issue templates #91569

Merged
merged 18 commits into from
Apr 16, 2022
Merged

Conversation

AlexWaygood
Copy link
Member

A first step towards:

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

@AlexWaygood
Copy link
Member Author

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

Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

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

.github/ISSUE_TEMPLATE/bug.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/crash.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/crash.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/crash.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/security.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/security.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/security.md Outdated Show resolved Hide resolved
@AlexWaygood AlexWaygood requested a review from hugovk April 15, 2022 17:19
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

.github/ISSUE_TEMPLATE/bug.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/crash.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/security.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/security.md Outdated Show resolved Hide resolved
AlexWaygood and others added 3 commits April 15, 2022 18:39
@AlexWaygood AlexWaygood requested a review from hugovk April 15, 2022 17:48
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

Copy link
Member

@ezio-melotti ezio-melotti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

.github/ISSUE_TEMPLATE/crash.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Show resolved Hide resolved
Copy link
Contributor

@erlend-aasland erlend-aasland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

.github/ISSUE_TEMPLATE/security.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug.md Outdated Show resolved Hide resolved
AlexWaygood and others added 3 commits April 15, 2022 20:15
Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: Erlend Egeberg Aasland <[email protected]>
@AlexWaygood
Copy link
Member Author

AlexWaygood commented Apr 15, 2022

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.

@AlexWaygood
Copy link
Member Author

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.

Copy link
Member

@ezio-melotti ezio-melotti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

.github/ISSUE_TEMPLATE/feature.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/crash.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/crash.md Show resolved Hide resolved
@ezio-melotti ezio-melotti merged commit 1169b0b into python:main Apr 16, 2022
@ezio-melotti ezio-melotti self-assigned this Apr 16, 2022
@AlexWaygood AlexWaygood deleted the issue-templates branch April 16, 2022 01:21
@AlexWaygood
Copy link
Member Author

Thanks everybody for the reviews!

@ezio-melotti
Copy link
Member

ezio-melotti commented Apr 16, 2022

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.

@ezio-melotti
Copy link
Member

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?

@AlexWaygood
Copy link
Member Author

AlexWaygood commented Apr 16, 2022

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.

@AlexWaygood
Copy link
Member Author

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.

@ezio-melotti
Copy link
Member

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.

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

Successfully merging this pull request may close these issues.

5 participants