Add development documentation to cmd/pipectl/README.md
メンテナーはふだん 2 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 82/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 静か
- 技術スタック
- go
- 領域
- cli, documentation
調査の方向性
まず cmd/pipectl/README.md と cmd/piped/README.md の開発ガイドを比較し、次に CONTRIBUTING.md の Development セクションを確認します。プレースホルダーを前提条件、一般的な make コマンド、pipectl をローカルでビルドして実行する手順に置き換えます。使用方法については、既存の user-guide/command-line-tool ドキュメントにリンクします。
索引モデルが issue の本文から書いたものです。
説明
What would you like to be added:
Development documentation in cmd/pipectl/README.md. The file has been a one-line placeholder ("# pipectl: A Command Line Tool for PipeCD") since it was added in #4441, while other components such as cmd/piped and cmd/pipecd have full development guides in their READMEs.
It should cover the basics following the structure of cmd/piped/README.md: prerequisites, common make commands, and how to build and run pipectl locally during development. Usage documentation already exists on the docs site (user-guide/command-line-tool), so the README can link there for usage and focus on development.
Why is this needed:
CONTRIBUTING.md (Development section) links to this README and says "You can find detailed development information in the README file of each directory", but the file contains no development information. Contributors who follow that link find nothing about how to build or test pipectl.
- 主要言語
- Go
- スター
- 1.4k
- フォーク
- 391
- 平均マージ
- 4日 1時間
- マージ済み PR（30日）
- 58
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
pipe-cd/pipecd のほかの issue
-
Applications at the repository root are not triggered by new commits対応中かも @Daksha1611 が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
メンテナーはふだん 2 日以内に返信
-
pipedv1 kubernetes plugins ignore trafficRouting.istio.host in K8S_TRAFFIC_ROUTING対応中かも @Dhirenderchoudhary が 1 日前に担当しました。 オープン
難易度 2/5 半日 初心者へのやさしさ 74/100
pipe-cd/pipecd#7626 · コメント 1 件 ·
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 2 日以内に返信
-
pipectl transfer restore application drops backed-up labels対応中かも @bhavishyajain545 が 2 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
pipe-cd/pipecd#7622 · コメント 1 件 ·
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
メンテナーはふだん 2 日以内に返信
似ている issue
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
メンテナーはふだん 2 日以内に返信
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
volcano-sh/volcano#6323 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
jbaruch/agentic-context-registry#201 ·
メンテナーはふだん 1 日以内に返信
-
needs-triage typo
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
llm-d-incubation/llm-d-scaling-manager#122 ·
メンテナーはふだん 1 日以内に返信