saltstack/salt

[BUG] Improve and reference Changelog docs in PR docs

Open

#59.854 geöffnet am 20. März 2021

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (5.508 Forks)batch import
bugdoc-requestdocumentationgood first issuehelp-wantedseverity-lowtime-estimate-sprint

Repository-Metriken

Stars
 (13.710 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 72T 6h) (221 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Überprüfen Sie die vorhandene Changelog Dokumentation unter docs.saltproject.io/en/latest/topics/development/changelog.html und die Beitragsseite unter docs.saltproject.io/en/latest/topics/development/contributing.html. Identifizieren Sie, wie der Changelog Abschnitt in die Beitragsseite integriert werden kann, möglicherweise durch Verschieben oder Verweisen, und aktualisieren Sie die Dokumentation entsprechend.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75