python / python/devguide

Improvements to Lifecycle of a pull request

Aperta
#1,358 4 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Python
Stelle
2.1k
Fork
1k
Merge medio
2g 12h
PR unite (30g)
12

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dalla pagina collegata “Lifecycle of a pull request” nella Python developer’s guide e rivedi le sezioni Quick guide, Step-by-step guide e Making good commits. Aggiorna la documentazione per includere il record NEWS.d e le convenzioni di denominazione e dei messaggi per gh-; il lavoro è completato quando tutti e quattro i dettagli del workflow richiesti sono indicati chiaramente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.