Title: More clearly document what the contents of NEWS entries should be · Issue #935 · python/devguide · GitHub
Open Graph Title: More clearly document what the contents of NEWS entries should be · Issue #935 · python/devguide
X Title: More clearly document what the contents of NEWS entries should be · Issue #935 · python/devguide
Description: The devguide describes in great detail how and when to write NEWS entries (reST syntax, line length, using blurb, etc.), but it barely touches on the subject of what the NEWS entry should contain. IMO we should prioritise telling what a ...
Open Graph Description: The devguide describes in great detail how and when to write NEWS entries (reST syntax, line length, using blurb, etc.), but it barely touches on the subject of what the NEWS entry should contain. ...
X Description: The devguide describes in great detail how and when to write NEWS entries (reST syntax, line length, using blurb, etc.), but it barely touches on the subject of what the NEWS entry should contain. ...
Opengraph URL: https://github.com/python/devguide/issues/935
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"More clearly document what the contents of NEWS entries should be","articleBody":"The devguide describes in great detail _how_ and _when_ to write NEWS entries (reST syntax, line length, using blurb, etc.), but it barely touches on the subject of what the NEWS entry should _contain_. IMO we should prioritise telling what a NEWS entry is, rather than how to write it.\r\n\r\n- Audience: Who are we writing for? This affects the detail level, and the tone of the text. This varies depending on NEWS category.\r\n- Don't be verbose: NEWS entries are a part of a very long changelog. IMO, we should promote brevity.\r\n- NEWS entries should communicate the actual change accurately in a way readers of the changelog will understand.\r\n- NEWS entries should be stand-alone; they should not be dependent on the actual diff when it comes to describing the change.\r\n\r\nhttps://devguide.python.org/core-developers/committing/?highlight=news%20entry#updating-news-and-what-s-new-in-python","author":{"url":"https://github.com/erlend-aasland","@type":"Person","name":"erlend-aasland"},"datePublished":"2022-08-11T12:59:23.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":4},"url":"https://github.com/935/devguide/issues/935"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:f01bc166-8199-c299-8977-1fe55bdf7b2c |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | D790:71616:76B266:A5DC75:696A7C69 |
| html-safe-nonce | acbed5578ce3d86183ae8f16c4fc124bfe7591050f3c7e907b5a2dc7a8ca8ffe |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJENzkwOjcxNjE2Ojc2QjI2NjpBNURDNzU6Njk2QTdDNjkiLCJ2aXNpdG9yX2lkIjoiNTQ4MDg5OTcxMDU1OTA5MTgxOCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 735e1c42841604392ad7305f25f34573a94c2847c474379545ac90d47cadd4c1 |
| hovercard-subject-tag | issue:1335926446 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python/devguide/935/issue_layout |
| twitter:image | https://opengraph.githubassets.com/c441993343919d9a841508eb12130e13b17ba6d97f5abe926adfc860534c95e8/python/devguide/issues/935 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/c441993343919d9a841508eb12130e13b17ba6d97f5abe926adfc860534c95e8/python/devguide/issues/935 |
| og:image:alt | The devguide describes in great detail how and when to write NEWS entries (reST syntax, line length, using blurb, etc.), but it barely touches on the subject of what the NEWS entry should contain. ... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | erlend-aasland |
| hostname | github.com |
| expected-hostname | github.com |
| None | 5b774e44f85c14a75886edd04ddda4e5a25ddebbb241bcbb590b08a3048730e8 |
| turbo-cache-control | no-preview |
| go-import | github.com/python/devguide git https://github.com/python/devguide.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 63972479 |
| octolytics-dimension-repository_nwo | python/devguide |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 63972479 |
| octolytics-dimension-repository_network_root_nwo | python/devguide |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | cc5f4eee261b3601c1e98e217ceaf28508b9567e |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width