envoyproxy/envoy

Use validate tags to auto generate markup

Open

#3,092 opened on 2018年4月16日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
api/v3area/docshelp wantedpriority/high

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (平均マージ 8d) (30d で 378 merged PRs)

説明

It would be nice to leverage protoc-gen-validate tags to autogenerate markup about field constraints.

For instance for https://github.com/envoyproxy/data-plane-api/blob/2f7459baf7c95cf7e634f848948a022c4b16fa79/api/eds.proto#L94 it would be nice to add a note that mentioned the constraint.

Migrated from https://github.com/envoyproxy/data-plane-api/issues/311

コントリビューターガイド

調査方針
protoc gen validate タグを使用して、Envoy のプロトファイル内のフィールド制約のマークアップを自動生成する方法を調査してください。data plane api リポジトリの既存のドキュメント生成を確認してください。
技術スタック
cpp
領域
documentationbackend
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
古い
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Git
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
40