Improve the "Making Good PRs" section

Aberta
#931 14 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

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

Direção de pesquisa

Comece localizando a seção "Making Good PRs" no guia para desenvolvedores e revisando a hierarquia da documentação ao redor. Decida como a seção deve abordar títulos e descrições precisos e concisos de pull requests e se deve ficar em um nível mais alto. O trabalho estará concluído quando as orientações e seu posicionamento refletirem claramente as melhorias sugeridas pela issue.

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

Descrição

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?

Linguagem predominante
Python
Estrelas
2.1k
Forks
1k
Merge médio
2d 12h
PRs com merge (30d)
12

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.

Mais de python/devguide

Todas as issues de python/devguide

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

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