python / python/devguide

Improvements to Lifecycle of a pull request

Offen
#1,358 4 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

I write this issue as a feedback from Euro Python 2024 sprint to denote troubles I encountered as I contributed to cpython.

Describe the enhancement or feature you'd like
Missing content in "Lifecycle of a pull request" https://devguide.python.org/getting-started/pull-request-lifecycle/

  • "Quick guide" is missing a step to create NEWS.d record. It's just very briefly mentioned in patchcheck.
  • "Step-by-step guide" doesn't denote a branch naming convention. I was told to use gh-<number>-<name>.
  • "Making good commits" doesn't mention gh-<number> should be included in the commit message.
  • "Step-by-step guide" doesn't mention gh-<number> should be included in the PR title.

Describe alternatives you've considered
None.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der verlinkten Seite „Lifecycle of a pull request“ im Python developer’s guide und prüfe deren Abschnitte Quick guide, Step-by-step guide und Making good commits. Aktualisiere die Dokumentation, sodass der NEWS.d record sowie die Namens- und Nachrichtenkonventionen für gh- abgedeckt sind; abgeschlossen ist die Aufgabe, wenn alle vier angeforderten Workflow-Details klar angegeben sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.