-
Notifications
You must be signed in to change notification settings - Fork 5.6k
[BUG] Improve and reference Changelog docs in PR docs #59854
Copy link
Copy link
Open
Labels
bugbroken, incorrect, or confusing behaviorbroken, incorrect, or confusing behaviordoc-requestnet new docs requestednet new docs requesteddocumentationRelates to Salt documentationRelates to Salt documentationgood first issuegood for someone new to saltgood for someone new to salthelp-wantedCommunity help is needed to resolve thisCommunity help is needed to resolve thisseverity-low4th level, cosemtic problems, work around exists4th level, cosemtic problems, work around existstime-estimate-sprint
Milestone
Description
Activity
Metadata
Metadata
Assignees
Labels
bugbroken, incorrect, or confusing behaviorbroken, incorrect, or confusing behaviordoc-requestnet new docs requestednet new docs requesteddocumentationRelates to Salt documentationRelates to Salt documentationgood first issuegood for someone new to saltgood for someone new to salthelp-wantedCommunity help is needed to resolve thisCommunity help is needed to resolve thisseverity-low4th level, cosemtic problems, work around exists4th level, cosemtic problems, work around existstime-estimate-sprint
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.