Add development documentation to cmd/pipectl/README.md
I maintainer di solito rispondono entro 2 giorni
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 82/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Tranquilla
- Stack tecnologico
- go
- Ambito
- cli, documentation
Direzione di ricerca
Inizia confrontando cmd/pipectl/README.md con la guida allo sviluppo in cmd/piped/README.md, quindi controlla la sezione Development di CONTRIBUTING.md. Sostituisci il segnaposto con i prerequisiti, i comandi make più comuni e le istruzioni per compilare ed eseguire pipectl localmente; inserisci un link alla documentazione esistente user-guide/command-line-tool per l’utilizzo.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- Go
- Stelle
- 1.4k
- Fork
- 391
- Merge medio
- 4g 1h
- PR unite (30g)
- 58
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di pipe-cd/pipecd
-
Applications at the repository root are not triggered by new commitsForse già presa @Daksha1611 l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
I maintainer di solito rispondono entro 2 giorni
-
pipedv1 kubernetes plugins ignore trafficRouting.istio.host in K8S_TRAFFIC_ROUTINGForse già presa @Dhirenderchoudhary l’ha presa 1 giorno fa. Aperta
Difficoltà 2/5 Mezza giornata Idoneità per principianti 74/100
pipe-cd/pipecd#7626 · 1 commento ·
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 2 giorni
-
pipectl transfer restore application drops backed-up labelsForse già presa @bhavishyajain545 l’ha presa 2 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100
pipe-cd/pipecd#7622 · 1 commento ·
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 83/100
I maintainer di solito rispondono entro 2 giorni
Tutte le issue di pipe-cd/pipecd
Issue simili
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
I maintainer di solito rispondono entro 2 giorni
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
volcano-sh/volcano#6323 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
jbaruch/agentic-context-registry#201 ·
I maintainer di solito rispondono entro 1 giorno
-
needs-triage typo
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
llm-d-incubation/llm-d-scaling-manager#122 ·
I maintainer di solito rispondono entro 1 giorno