saltstack/salt

[BUG] Improve and reference Changelog docs in PR docs

Open

#59.854 aperta il 20 mar 2021

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Python (5508 fork)batch import
bugdoc-requestdocumentationgood first issuehelp-wantedseverity-lowtime-estimate-sprint

Metriche repository

Star
 (13.710 star)
Metriche merge PR
 (Merge medio 72g 6h) (221 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina la documentazione esistente del changelog su docs.saltproject.io/en/latest/topics/development/changelog.html e la pagina dei contributi su docs.saltproject.io/en/latest/topics/development/contributing.html. Identifica come integrare la sezione del changelog nella pagina dei contributi, eventualmente spostandola o facendo riferimento ad essa, e aggiorna la documentazione di conseguenza.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75