pingcap/tiflow

Add help docs for makefile

Ouverte

#6 493 ouverte le 27 juil. 2022

Voir sur GitHubGuide contributeur
 (1 commentaire) (1 réaction) (0 personne assignée)Go (310 forks)auto 404
area/ticdcgood first issuetype/feature

Métriques du dépôt

Stars
 (461 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Lisez l'article de reference et le Makefile, puis ajoutez des commentaires d'aide pour chaque cible en suivant le motif decrit.
Stack technique
go
Domaine
documentationbuild system
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitMake
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85