-
-
Notifications
You must be signed in to change notification settings - Fork 838
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
Rework the docs for NEWS/What's New entries #1238
Rework the docs for NEWS/What's New entries #1238
Conversation
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
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.
Thanks, this is great! I agree that https://github.com/python/devguide/pull/1238/files#r1417449912 would improve things further.
Also: should we think about moving this information to a different file altogether? This information isn't just relevant to core developers; it's relevant to any contributors.
It's possible (and easy) for core developers to add NEWS entries to other contributors' PRs, but few core devs do so; the de-facto expectation is that contributors should write their own NEWS entries
Co-authored-by: Hugo van Kemenade <[email protected]>
That's a good idea. Let's do it in a follow-up PR. |
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
I'm very pleased with how this turned out. Thanks for your input, everyone! I'll land tomorrow. |
@AlexWaygood and @ezio-melotti, I've created follow-up issues for your suggestions regarding further improvements. Let me know if I forgot something. |
(Some minor wording changes might have snuck in, but largely, I kept the existing text.)
📚 Documentation preview 📚: https://cpython-devguide--1238.org.readthedocs.build/core-developers/committing/#updating-news-and-what-s-new-in-python