Add development documentation to cmd/pipectl/README.md
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 1.4k
- Forks
- 364
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 84
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing cmd/pipectl/README.md with the development guide in cmd/piped/README.md, then check the Development section of CONTRIBUTING.md. Replace the placeholder with prerequisites, common make commands, and instructions for building and running pipectl locally; link to the existing user-guide/command-line-tool documentation for usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 82/100