-
-
Notifications
You must be signed in to change notification settings - Fork 31k
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
Add minimal issue templates #91569
Conversation
(It's the first time I've tried setting up issue templates, so please review carefully.) |
There was a problem hiding this 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
Co-authored-by: Hugo van Kemenade <[email protected]>
There was a problem hiding this 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
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
There was a problem hiding this 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
ornew
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
Co-authored-by: Ezio Melotti <[email protected]> Co-authored-by: Erlend Egeberg Aasland <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
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 |
Neither am I, tbh, but as you say -- they're not really for us; they're for people who are new to CPython :)
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. |
There was a problem hiding this 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
Co-authored-by: Ezio Melotti <[email protected]>
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 |
It might actually be better to remove the |
Yup, I think that's best! I had no idea having the |
|
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. |
A first step towards:
python/cpython
core-workflow#437These are largely derived from the mypy issue templates, which I think are pretty effective (more effective than what CPython has currently, anyway 🙂)