protocolbuffers / protocolbuffers/protocolbuffers.github.io
Typos and confusing docs in the "Go Generated Code Guide (Open)"
オープン
初心者向け
まだ誰も着手していません。
- 主要言語
- HTML
- スター
- 69
- フォーク
- 179
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
There's a few typos and mis-documentations in the Go generated code guide:
- "Singular Explicit Presence Scalar Fields" and "Singular Implicit Presence Scalar Fields" have the same field definition, yet they claim to generate different structs, one with a
BirthYear int32and one with aBirthYear *int32. - The docs reference
FirstActiveYearbut no field of that name exists at HEAD. It was removed in https://github.com/protocolbuffers/protocolbuffers.github.io/pull/266. cc @Logofile - Message "Concer" is misspelled.
Thanks for taking a look!
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず「Go Generated Code Guide (Open)」のドキュメントを見つけ、単数形における明示的 Presence と暗黙的 Presence の例を比較します。一致していないフィールド定義と生成された struct を修正し、廃止された FirstActiveYear への参照を削除して、「Concer」の誤字を修正します。完了の条件は、ガイドが現在の生成コードの動作と一致し、列挙されたエラーが一つも含まれていないことです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- go
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 静か
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 78/100