pingcap/tiflow

Add help docs for makefile

Aberta

#6.493 aberto em 27 de jul. de 2022

Ver no GitHubGuia do colaborador
 (1 comentário) (1 reação) (0 responsável)Go (310 forks)auto 404
area/ticdcgood first issuetype/feature

Métricas do repositório

Stars
 (461 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

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

Guia do colaborador

Direção de pesquisa
Leia o artigo referenciado e o Makefile, adicione comentários de ajuda para cada target seguindo o padrão descrito.
Pilha de tecnologia
go
Domain
documentationbuild system
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitMake
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85