python / python/docs-community

Changing docs for trivial issues

未关闭
#50 28 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

doc:styleguide
主要语言
Makefile
星标
55
派生
26
PR 合并指标
30 天内没有已合并 PR

描述

There's this open issue right now on British vs American spelling:

https://github.com/python/cpython/issues/82221

In the past, there's been some merged PRs on similar smallish consistency/grammar issues:

https://github.com/python/cpython/pull/2787
https://github.com/python/cpython/pull/25985

However, there are also these other comments that seem to resist against trivial changes:

https://github.com/python/cpython/issues/58372#issuecomment-1093572060
https://github.com/python/cpython/issues/62480#issuecomment-1093619748

The sense that I'm getting is that trivial / minor grammatical / consistency issues are generally not considered if it's either unreported, too large such that it'll take more core dev reviewing time than it's worth in improvement, or touches on somewhat historical docs. Would this be an accurate summary on whether to consider committing small changes?

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

审查关于英式/美式拼写以及语法或一致性方面小幅更改的关联 issue 和 pull request,然后比较 issue 58372 和 62480 中的反对意见。待项目对于是否接受琐碎文档更改的立场为贡献者清晰总结后,这项工作即告完成。

由索引模型根据 Issue 内容生成。

评估

领域
documentation
Issue 类型
文档
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
20/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。