python / python/devguide

Clarify where docs fixes can be backported

Aperta
#1,069 6 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

needs: decision type-bug type-feature
Lingua principale
Python
Stelle
2.1k
Fork
1k
Merge medio
2g 12h
PR unite (30g)
12

Descrizione

The status key for branches has lists of changes that can go in, and the lists look exclusive:

feature:

  • new features, bugfixes, and security fixes are accepted.

prerelease:

  • feature fixes, bugfixes, and security fixes are accepted for the upcoming feature release.

bugfix:

  • bugfixes and security fixes are accepted, new binaries are still released. (Also called maintenance mode or stable release)

security:

  • only security fixes are accepted and no more binaries are released, but new source-only versions can be released

end-of-life:

  • release cycle is frozen; no further changes can be pushed to it.

This makes it a bit awkward to backport docs changes, especially now that the lists are included in the tag descriptions.

AFAIK, docs fixes don't need RM approval in feature, prerelease and bugfix branches. (Security branches are locked so any change needs the RM in the loop.)
Is that right, @pablogsal @Yhg1s ?

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 con la chiave di stato collegata in Python Developer’s Guide e confronta le descrizioni dei suoi branch con la domanda su docs-backport riportata. Conferma con i maintainer di riferimento le regole di approvazione per le correzioni alla documentazione nei branch feature, prerelease, bugfix e security; il lavoro è completato quando la pagina indica chiaramente verso quali branch è possibile fare il backport delle modifiche alla documentazione e se è necessaria l’approvazione di RM.

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

Valutazione

Stack tecnologico
python
Ambito
documentation, release
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.