saltstack/salt

[BUG] Improve and reference Changelog docs in PR docs

オープン

#59,854 opened on 2021/03/20

GitHub で見るコントリビューターガイド
 (2 件のコメント) (0 件のリアクション) (0 人の担当者)Python (5,508 件のフォーク)batch import
bugdoc-requestdocumentationgood first issuehelp-wantedseverity-lowtime-estimate-sprint

Repository metrics

Stars
 (13,710 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Git
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75