saltstack/salt

[BUG] Improve and reference Changelog docs in PR docs

Open

#59 854 ouverte le 20 mars 2021

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)Python (5 508 forks)batch import
bugdoc-requestdocumentationgood first issuehelp-wantedseverity-lowtime-estimate-sprint

Métriques du dépôt

Stars
 (13 710 stars)
Métriques de merge PR
 (Merge moyen 72j 6h) (221 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Inspectez la documentation existante du changelog sur docs.saltproject.io/en/latest/topics/development/changelog.html et la page de contribution sur docs.saltproject.io/en/latest/topics/development/contributing.html. Identifiez comment intégrer la section du changelog dans la page de contribution, éventuellement en la déplaçant ou en y faisant référence, et mettez à jour la documentation en conséquence.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75