protocolbuffers / protocolbuffers/protobuf-javascript

Need to better document that toObject() is *not* proto3 JSON

オープン
#95 コメント 20 件 リアクション 6 件 担当者 0 名 GitHub で見る

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

documentation enhancement javascript json triaged
主要言語
JavaScript
スター
471
フォーク
91
平均マージ
3時間 57分
マージ済み PR(30日)
2

説明

proto3 JSON mapping specifies special output for some well known types (e.g. Timestamp, Duration). However, the generated _pb.js files for these types treats them as regular protobufs.

Repro code:

var tspb = require('google-protobuf/google/protobuf/timestamp_pb.js');
var t = new tspb.Timestamp();
console.log(t.toObject());

Expected output:
0001-01-01T00:00:00Z

Observed output:
{ seconds: 0, nanos: 0 }

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

issue にリンクされている proto3 JSON マッピングと、再現手順で示されている生成ファイル google-protobuf/google/protobuf/timestamp_pb.js の動作から始めてください。well-known types について、toObject() は proto3 JSON ではなく通常の protobuf オブジェクトを返すことをドキュメントで明確にし、提示された Timestamp の例に照らして記述を確認してください。

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

評価

技術スタック
javascript
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

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

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