GoogleCloudPlatform / GoogleCloudPlatform/cloud-sql-proxy
Align README and Proxy help message documentation
オープン
まだ誰も着手していません。
priority: p2
type: cleanup
- 主要言語
- Go
- スター
- 1.4k
- フォーク
- 352
- 平均マージ
- 14時間 54分
- マージ済み PR（30日）
- 5
説明
This bug is to track adding the details of the Proxy help message to the README documentation and align on a process for documenting new flags moving forward.
Currently when we add a new flag/feature we prioritize adding it to the Proxy's help command https://github.com/GoogleCloudPlatform/cloud-sql-proxy/blob/main/cmd/root.go#L112
However, ideally we have the README and help message provide the same information so that users can find the relevant info no matter where they look.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
評価
この issue はまだ評価されていません。