python / python/devguide

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

Aberta
#358 3 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

help wanted topic-pull requests type-bug type-feature
Linguagem predominante
Python
Estrelas
2.1k
Forks
1k
Merge médio
2d 12h
PRs com merge (30d)
12

Descrição

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.

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Leia Git Bootcamp e Cheat Sheet, a seção Accepting Pull Requests e a seção Lifecycle of a Pull Request no devguide. Consolide o texto existente e as orientações de MiscNEWS.d na seção Git Bootcamp, adicione orientações sobre boas entradas de NEWS e crie um link para ela em todos os lugares onde a criação, a revisão ou o commit de PRs forem discutidos.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Domínio
documentation
Tipo de issue
Documentação
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.