Add more examples to the NEWS/What's New docs

Offen

#1,243 erstellt am 07.12.2023 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 2/5
Geschätzter Aufwand: 1-3 Stunden
Anfängerfreundlichkeit: 52/100

Issue-Typ: Dokumentation
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: python
Bereich: documentation

Rechercherichtung

Finde die in der Issue referenzierte NEWS-/What's-New-Dokumentation und prüfe ihre aktuellen Hinweise dazu, wann ein NEWS-Eintrag hinzugefügt werden soll. Füge prägnante gute und schlechte Beispiele hinzu, einschließlich der aufgeführten Fälle zu Python-Releases, Dokumentation, Tests, private API und Refactoring. Überprüfe, dass die Beispiele klar dargestellt werden und zu den umgebenden Hinweisen passen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

good first issue

I think having a concise list is good, but if we want to elaborate more and clarify we could also provide some examples. An example for this is "a new feature was included in Python 3.13 alpha 1, but got removed in 3.13 beta 2, before the final release of 3.13.".

If we add examples, we could follow the ✔️ good/❌ bad format and do one or two lists with examples like:
✅ the following examples need a NEWS entry:
* a new function, method, class, module
* a new HOWTO in the documentation
* the removal of a deprecated feature
* ...

❌ the following examples *don't* need a NEWS entry:
* a new feature was included in Python 3.13 alpha 1, but got removed in 3.13 beta 2, > before the final release of 3.13
* a typo fix in the documentation or in a docstring
* the addition of a new test method
* the removal of a private and internal API
* code refactoring of a module with no user-visible effects

Originally posted by @ezio-melotti in https://github.com/python/devguide/pull/1238#discussion_r1417763167

Vorherrschende Sprache: Python
Sterne: 2.1k
Forks: 1k
Ø Merge: 2 T. 12 Std.
Gemergte PRs (30 T.): 12

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus python/devguide

Feature: Document SELinux bind-mount note for local devcontainer usage Offen

type-feature

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

python/devguide#1879 · 1 Kommentar · Erstellt am 13.8.2026
Feature: Add Homebrew as a way to get build dependencies installed on Linux Offen

type-feature

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

python/devguide#1791 · 2 Kommentare · 1 Reaktion · Erstellt am 20.4.2026
Feature: Add instructions about JIT builds Offen

topic-building python type-feature

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100

python/devguide#1620 · 1 Kommentar · Erstellt am 02.8.2025
Update test command on dev guide landing page Offen

needs: decision topic-test type-bug

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100

python/devguide#1171 · 10 Kommentare · Erstellt am 29.9.2023
Explain how to revert maintenance branch commits Offen

topic-dev process type-feature

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100

python/devguide#319 · 4 Kommentare · 3 Reaktionen · Erstellt am 30.1.2018

Alle Issues in python/devguide