python / python/devguide

Clarify where docs fixes can be backported

Ouverte
#1,069 6 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

needs: decision type-bug type-feature
Langage dominant
Python
Étoiles
2.1k
Forks
1k
Merge moyen
2 j 12 h
PR mergées (30 j)
12

Description

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 ?

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la clé d’état liée dans Python Developer’s Guide et comparez les descriptions de ses branches avec la question docs-backport formulée. Confirmez auprès des maintainers concernés les règles d’approbation applicables aux corrections de documentation sur les branches feature, prerelease, bugfix et security ; le travail est terminé lorsque la page indique clairement vers quelles branches les modifications de documentation peuvent être backportées et si l’approbation de RM est requise.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation, release
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.