Add more examples to the NEWS/What's New docs
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 2.1k
- フォーク
- 1k
- 平均マージ
- 2日 12時間
- マージ済み PR(30日)
- 12
説明
I think having a concise list is good, but if we want to elaborate more and clarify we could also provide some examples. An example for this is "a new feature was included in Python 3.13 alpha 1, but got removed in 3.13 beta 2, before the final release of 3.13.".
If we add examples, we could follow the ✔️ good/❌ bad format and do one or two lists with examples like:
✅ the following examples need a NEWS entry: * a new function, method, class, module * a new HOWTO in the documentation * the removal of a deprecated feature * ... ❌ the following examples *don't* need a NEWS entry: * a new feature was included in Python 3.13 alpha 1, but got removed in 3.13 beta 2, > before the final release of 3.13 * a typo fix in the documentation or in a docstring * the addition of a new test method * the removal of a private and internal API * code refactoring of a module with no user-visible effects
Originally posted by @ezio-melotti in https://github.com/python/devguide/pull/1238#discussion_r1417763167
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
issue で参照されている NEWS/What's New ドキュメントを見つけ、NEWS エントリを追加するタイミングについての現在の指針を確認してください。Python のリリース、ドキュメント、テスト、private API、リファクタリングについて、一覧にあるケースを含む、簡潔な良い例と悪い例を追加してください。例が明確に表示され、周囲の指針と一致していることを確認してください。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 52/100