Add development documentation to cmd/pipectl/README.md

Aperta Adatta ai principianti
#7,016 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

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

kind/enhancement

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

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di pipe-cd/pipecd

Tutte le issue di pipe-cd/pipecd

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.