The Wayback Machine - https://web.archive.org/web/20210606233658/https://github.com/saltstack/salt/issues/59854
Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
danielrobbins opened this issue Mar 20, 2021 · 1 comment
Open

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

danielrobbins opened this issue Mar 20, 2021 · 1 comment

Comments

@danielrobbins
Copy link

@danielrobbins danielrobbins commented Mar 20, 2021

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.

@OrangeDog
Copy link
Collaborator

@OrangeDog OrangeDog commented Mar 22, 2021

It is referenced in the PR template at least.

@sagetherage sagetherage added this to the Approved milestone Mar 23, 2021
@sagetherage sagetherage added this to To do in Salt Docs via automation Mar 23, 2021
@sagetherage sagetherage moved this from To do to In progress in Salt Docs Mar 23, 2021
@sagetherage sagetherage moved this from In progress to To do in Salt Docs Apr 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants