Clarify where docs fixes can be backported

Aberta
#1,069 6 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
35/100
Tipo de issue
Documentação
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
documentation, release

Direção de pesquisa

Comece pela chave de status vinculada no Python Developer’s Guide e compare as descrições de suas branches com a questão de docs-backport apresentada. Confirme com os maintainers relevantes as regras de aprovação para correções na documentação nas branches feature, prerelease, bugfix e security; considera-se concluído quando a página indicar claramente para quais branches as alterações na documentação podem ser portadas de volta e se a aprovação de RM é necessária.

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

Descrição

needs: decision type-bug type-feature

The status key for branches has lists of changes that can go in, and the lists look exclusive:

feature:

  • new features, bugfixes, and security fixes are accepted.

prerelease:

  • feature fixes, bugfixes, and security fixes are accepted for the upcoming feature release.

bugfix:

  • bugfixes and security fixes are accepted, new binaries are still released. (Also called maintenance mode or stable release)

security:

  • only security fixes are accepted and no more binaries are released, but new source-only versions can be released

end-of-life:

  • release cycle is frozen; no further changes can be pushed to it.

This makes it a bit awkward to backport docs changes, especially now that the lists are included in the tag descriptions.

AFAIK, docs fixes don't need RM approval in feature, prerelease and bugfix branches. (Security branches are locked so any change needs the RM in the loop.)
Is that right, @pablogsal @Yhg1s ?

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.