saltstack/salt

[BUG] Improve and reference Changelog docs in PR docs

Open

#59,854 建立於 2021年3月20日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)Python (13,710 star) (5,508 fork)batch import
bugdoc-requestdocumentationgood first issuehelp-wantedseverity-lowtime-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.

貢獻者指南

技術棧
python
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
90
研究方向
The task involves updating the contributing.html documentation to include the changelog section from changelog.html. The issue suggests moving the changelog section inside the contributing section. The contributor should review both files (links provided in the issue) and restructure the documentation accordingly. No maintainer response needed.