[BUG] Improve and reference Changelog docs in PR docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the Changelog documentation at docs.saltproject.io/en/latest/topics/development/changelog.html and the PR guidance in docs.saltproject.io/en/latest/topics/development/contributing.html. Integrate the Changelog guidance into the contributing steps and verify that the PR process clearly explains when community contributors should write changelog entries.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100