Skip to content

[BUG] Improve and reference Changelog docs in PR docs #59854

@danielrobbins

Description

@danielrobbins

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugbroken, incorrect, or confusing behaviordoc-requestnet new docs requesteddocumentationRelates to Salt documentationgood first issuegood for someone new to salthelp-wantedCommunity help is needed to resolve thisseverity-low4th level, cosemtic problems, work around existstime-estimate-sprint

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions