saltstack/salt

[BUG] Improve and reference Changelog docs in PR docs

开放

#59,854 创建于 2021年3月20日

在 GitHub 查看贡献者指南
 (2 条评论) (0 个反应) (0 位负责人)Python (5,508 个派生)batch import
bugdoc-requestdocumentationgood first issuehelp-wantedseverity-lowtime-estimate-sprint

仓库指标

星标
 (13,710 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

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.

贡献者指南

研究方向
查看现有的变更日志文档（docs.saltproject.io/en/latest/topics/development/changelog.html）和贡献页面（docs.saltproject.io/en/latest/topics/development/contributing.html）。确定如何将变更日志部分集成到贡献页面中，可能需要移动或引用它，并相应地更新文档。
技术栈
python
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75