Add development documentation to cmd/pipectl/README.md
维护者通常 2 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 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 小时
- 30 天内合并 PR
- 58
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 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
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 2 天内回复
-
pipectl transfer restore application drops backed-up labels可能已有人在做 @bhavishyajain545 于 2 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 86/100
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 83/100
维护者通常 2 天内回复
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
-
bug
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 64/100
kubernetes-sigs/kubebuilder#6187 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
OffchainLabs/prysm#17876 ·
维护者通常 1 天内回复
-
enhancement
难度 2/5 1-3 小时 新手友好度 62/100
维护者通常 2 天内回复