saltstack/salt

[BUG] Improve and reference Changelog docs in PR docs

Open

#59,854 opened on 2021年3月20日

GitHub で見る
 (2 comments) (0 reactions) (0 assignees)Python (13,710 stars) (5,508 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.
[BUG] Improve and reference Changelog docs in PR docs · saltstack/salt#59854 | Good First Issue