python / python/devguide

Clarify where docs fixes can be backported

未關閉
#1,069 6 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

needs: decision type-bug type-feature
主要語言
Python
星號
2.1k
分支
1k
平均合併
2 天 12 小時
30 天內合併 PR
12

描述

The status key for branches has lists of changes that can go in, and the lists look exclusive:

feature:

  • new features, bugfixes, and security fixes are accepted.

prerelease:

  • feature fixes, bugfixes, and security fixes are accepted for the upcoming feature release.

bugfix:

  • bugfixes and security fixes are accepted, new binaries are still released. (Also called maintenance mode or stable release)

security:

  • only security fixes are accepted and no more binaries are released, but new source-only versions can be released

end-of-life:

  • release cycle is frozen; no further changes can be pushed to it.

This makes it a bit awkward to backport docs changes, especially now that the lists are included in the tag descriptions.

AFAIK, docs fixes don't need RM approval in feature, prerelease and bugfix branches. (Security branches are locked so any change needs the RM in the loop.)
Is that right, @pablogsal @Yhg1s ?

貢獻指南

開啟貢獻指南

從這裡開始

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

研究方向

從 Python Developer’s Guide 中連結的狀態鍵開始,並將其中的分支描述與所述的 docs-backport 問題進行比較。向相關 maintainer 確認 feature、prerelease、bugfix 和 security 分支上文件修正的核准規則;完成的標準是頁面明確說明文件變更可以 backport 到哪些分支,以及是否需要 RM 核准。

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

評估

技術堆疊
python
領域
documentation, release
Issue 類型
文件
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
需要釐清
新手友好度
35/100

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

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