pingcap/tiflow

Add help docs for makefile

Aperta

#6493 aperta il 27 lug 2022

Vedi su GitHubGuida contributor
 (1 commento) (1 reazione) (0 assegnatari)Go (310 fork)auto 404
area/ticdcgood first issuetype/feature

Metriche repository

Star
 (461 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Is your feature request related to a problem?

For now, we have a bunch of make commands but no docs. It isn't easy to find the available commands.

Describe the feature you'd like

Adapt from https://www.thapaliya.com/en/writings/well-documented-makefiles/ and add help docs for each command.

Describe alternatives you've considered

No response

Teachability, Documentation, Adoption, Migration Strategy

No response

Guida contributor

Direzione di ricerca
Leggi l'articolo di riferimento e il Makefile, quindi aggiungi commenti di aiuto per ogni target seguendo il pattern descritto.
Tech stack
go
Dominio
documentationbuild system
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitMake
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85