python / python/docs-community

Changing docs for trivial issues

Ouverte
#50 28 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

doc:styleguide
Langage dominant
Makefile
Étoiles
55
Forks
26
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

There's this open issue right now on British vs American spelling:

https://github.com/python/cpython/issues/82221

In the past, there's been some merged PRs on similar smallish consistency/grammar issues:

https://github.com/python/cpython/pull/2787
https://github.com/python/cpython/pull/25985

However, there are also these other comments that seem to resist against trivial changes:

https://github.com/python/cpython/issues/58372#issuecomment-1093572060
https://github.com/python/cpython/issues/62480#issuecomment-1093619748

The sense that I'm getting is that trivial / minor grammatical / consistency issues are generally not considered if it's either unreported, too large such that it'll take more core dev reviewing time than it's worth in improvement, or touches on somewhat historical docs. Would this be an accurate summary on whether to consider committing small changes?

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

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

Examinez l’issue et les pull requests liés concernant l’orthographe britannique/américaine ainsi que les petites modifications de grammaire ou de cohérence, puis comparez les commentaires opposés dans les issues 58372 et 62480. Le travail est terminé lorsque la position du projet sur l’acceptation des modifications triviales de la documentation est clairement résumée pour les contributeurs.

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

Évaluation

Domaine
documentation
Type d'issue
Documentation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
20/100

Recevez les nouvelles issues par e-mail

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