Add development documentation to cmd/launcher/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/launcher/README.md. The file has been a one-line placeholder ("# Launcher") 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 briefly explain what the launcher is (the command executor that enables the remote upgrade feature of the piped agent) and cover prerequisites, common make commands, and how to build and run it locally, following the structure of cmd/piped/README.md.
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, test, or run the launcher.
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 with cmd/launcher/README.md and compare its structure with cmd/piped/README.md. Use the development section of CONTRIBUTING.md for context, then document prerequisites, common make commands, and local build and run steps for the launcher. Done means the README is a useful development guide rather than the current one-line placeholder.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 76/100