Improve the "Making Good PRs" section

Ouverte
#931 14 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
35/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Domaine
documentation

Piste de recherche

Commencez par localiser la section "Making Good PRs" dans le guide destiné aux développeurs et par examiner la hiérarchie de documentation environnante. Déterminez comment la section doit traiter les titres et les descriptions précis et concis des pull requests, et si elle doit se trouver à un niveau supérieur. Le travail est terminé lorsque les recommandations et leur emplacement reflètent clairement les améliorations suggérées par l'issue.

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

Description

good first issue type-bug type-feature

I often see PRs with misleading or vague titles. This is problematic, as the PR titles often end up being the commit titles, and commit titles are one of the most important tools we have when searching for historic changes. Bad titles impact maintainability.

Suggested edits:

  • Enforce a strict title format
  • Promote writing accurate and concise PR titles/descriptions

Perhaps the "Making Good PRs" section can be further promoted. Would it make sense to extract it and move it a level up in the doc hierarchy?

Langage dominant
Python
Étoiles
2.1k
Forks
1k
Merge moyen
2 j 12 h
PR mergées (30 j)
12

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.

Autres issues de python/devguide

Toutes les issues de python/devguide

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

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