Clarify where docs fixes can be backported
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
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 ?
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem verlinkten Statusschlüssel im Python Developer’s Guide und vergleiche seine Branch-Beschreibungen mit der dort formulierten docs-backport-Frage. Bestätige mit den zuständigen Maintainer:innen die Genehmigungsregeln für Dokumentationskorrekturen in Feature-, Prerelease-, Bugfix- und Security-Branches; abgeschlossen ist die Aufgabe, wenn die Seite klar angibt, wohin Änderungen an der Dokumentation zurückportiert werden können und ob die Genehmigung durch RM erforderlich ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation, release
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 35/100