Clarify where docs fixes can be backported
未关闭
还没有人认领这个 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 ?
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 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