saltstack/salt

[BUG] Improve and reference Changelog docs in PR docs

Open

#59.854 aberto em 20 de mar. de 2021

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)Python (5.508 forks)batch import
bugdoc-requestdocumentationgood first issuehelp-wantedseverity-lowtime-estimate-sprint

Métricas do repositório

Stars
 (13.710 stars)
Métricas de merge de PR
 (Mesclagem média 72d 6h) (221 fundiu PRs em 30d)

Description

We have Changelog documentation here:

https://docs.saltproject.io/en/latest/topics/development/changelog.html

However, this documentation is not integrated or referenced in our documentation on how to create PRs:

https://docs.saltproject.io/en/latest/topics/development/contributing.html

The "Changelog" section appears BEFORE the Contributing section, but should likely be placed INSIDE the Contributing section. It is a key part of our PR process, and we have several community contributors who write their own Changelog entries.

Thus, it should be integrated into the steps listed in contributing.html.

Guia do colaborador

Direção de pesquisa
Inspecione a documentação existente do changelog em docs.saltproject.io/en/latest/topics/development/changelog.html e a página de contribuição em docs.saltproject.io/en/latest/topics/development/contributing.html. Identifique como integrar a seção do changelog na página de contribuição, possivelmente movendo ou referenciando a, e atualize a documentação adequadamente.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75