Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Ensure that all references to creating and reviewing PRs mention blurb and NEWS entries

Ouverte
#358 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

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

Piste de recherche

Lisez Git Bootcamp et Cheat Sheet, la section Accepting Pull Requests et la section Lifecycle of a Pull Request dans le devguide. Regroupez le texte existant et les indications de MiscNEWS.d dans la section Git Bootcamp, ajoutez des indications sur les bonnes entrées NEWS et créez un lien vers cette section partout où la création, la revue ou le commit de PR sont abordés.

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

Description

help wanted topic-pull requests type-bug type-feature

Other than for the most trivial sorts of changes (e.g. obvious spelling errors), nearly all changes to the cpython repo should include a NEWS entry; that's our primary mechanism to communicate changes with downstream users. We should be encouraging everyone, including non core-developers to submit PRs with NEWS entries. Among other benefits, having a NEWS entry makes reviews of the PR easier and helps to focus everyone include the submitter on what problem the PR is trying to address. And the tool we have to create NEWS entry is blurb; we want to encourage everyone creating or modifying a PR to use it. It's easier to delete the occasional unnecessary NEWS item than it is to create one when committing. To that end, suggest:

  1. Create a section in the Git Bootcamp and Cheat Sheet Accepting and Merging section to describe the details of using blurb with a fallback to how to manually create a MiscNEWS.d entry: basically, adapt and move the detailed info from the Accepting Pull Requests section. We want to be careful to encourage blurb usage and not encourage manually creation as the details could change in the future.

  2. This section should also include some guidelines on what a good NEWS entry looks like, or, if not here, one place in the devguide with references to it.

  3. Review the whole document and add mentions of NEWS entries and the blurb command everywhere creating or reviewing or committing a PR is discussed and include a link to the detailed section created above. In particular, the Lifecycle of a Pull Request section needs to be edited to include blurb.

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.