python / python/devguide

Ensure that all references to creating and reviewing PRs mention blurb and NEWS entries

未關閉
#358 3 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

help wanted topic-pull requests type-bug type-feature
主要語言
Python
星號
2.1k
分支
1k
平均合併
2 天 12 小時
30 天內合併 PR
12

描述

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:

  1. Create a section in the Git Bootcamp and Cheat Sheet Accepting and Merging section to describe the details of using blurb with a fallback to how to manually create a MiscNEWS.d entry: basically, adapt and move the detailed info from the Accepting Pull Requests section. We want to be careful to encourage blurb usage and not encourage manually creation as the details could change in the future.

  2. 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.

  3. Review the whole document and add mentions of NEWS entries and the blurb command 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.

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

閱讀 devguide 中的 Git Bootcamp 和 Cheat Sheet、Accepting Pull Requests 部分以及 Lifecycle of a Pull Request 部分。將現有的簡介和 MiscNEWS.d 指南整合到 Git Bootcamp 部分中,加入關於撰寫良好 NEWS 項目的指南,並在所有討論 PR 建立、審查或提交的地方連結到該部分。

由索引模型根據 Issue 內容生成。

評估

領域
documentation
Issue 類型
文件
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。