python / python/docs-community

Changing docs for trivial issues

オープン
#50 コメント 28 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

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. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

イギリス英語/アメリカ英語の綴りと、文法や一貫性に関する小さな変更について、リンクされている issue と pull request を確認し、その後 issue 58372 と 62480 の反対意見のコメントを比較してください。プロジェクトが些細なドキュメント変更を受け入れることについての立場が、contributor 向けに明確にまとめられた時点で作業は完了です。

索引モデルが issue の本文から書いたものです。

評価

領域
documentation
issue の種類
ドキュメント
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
20/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。