Ensure that all references to creating and reviewing PRs mention blurb and NEWS entries
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
調査の方向性
devguide の Git Bootcamp と Cheat Sheet、Accepting Pull Requests セクション、Lifecycle of a Pull Request セクションを読んでください。既存の短い説明と MiscNEWS.d のガイダンスを Git Bootcamp セクションに統合し、良い NEWS エントリに関するガイダンスを追加して、PR の作成、レビュー、またはコミットについて説明しているすべての箇所からそこにリンクしてください。
索引モデルが issue の本文から書いたものです。
説明
Other than for the most trivial sorts of changes (e.g. obvious spelling errors), nearly all changes to the cpython repo should include a NEWS entry; that's our primary mechanism to communicate changes with downstream users. We should be encouraging everyone, including non core-developers to submit PRs with NEWS entries. Among other benefits, having a NEWS entry makes reviews of the PR easier and helps to focus everyone include the submitter on what problem the PR is trying to address. And the tool we have to create NEWS entry is blurb; we want to encourage everyone creating or modifying a PR to use it. It's easier to delete the occasional unnecessary NEWS item than it is to create one when committing. To that end, suggest:
-
Create a section in the Git Bootcamp and Cheat Sheet
Accepting and Mergingsection to describe the details of using blurb with a fallback to how to manually create aMiscNEWS.dentry: basically, adapt and move the detailed info from the Accepting Pull Requests section. We want to be careful to encourageblurbusage and not encourage manually creation as the details could change in the future. -
This section should also include some guidelines on what a good NEWS entry looks like, or, if not here, one place in the devguide with references to it.
-
Review the whole document and add mentions of NEWS entries and the
blurbcommand everywhere creating or reviewing or committing a PR is discussed and include a link to the detailed section created above. In particular, the Lifecycle of a Pull Request section needs to be edited to include blurb.
- 主要言語
- Python
- スター
- 2.1k
- フォーク
- 1k
- 平均マージ
- 2日 12時間
- マージ済み PR（30日）
- 12
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
python/devguide のほかの issue
-
type-feature
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
type-feature
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
topic-building python type-feature
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
needs: decision topic-test type-bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
topic-dev process type-feature
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
python/devguide の issue をすべて見る
似ている issue
-
🐛 Bug 🔔 Pending processing
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
jumpserver/jumpserver#17584 ·
-
link-check link-check:sphinx-theme
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 90/100
modelscope/DiffSynth-Studio#1702 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
qgis/QGIS-Documentation#11275 ·
-
bug priority:normal ready-for-dev
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
OpenHands/extensions#626 · コメント 1 件 ·