pingcap/tiflow

Add help docs for makefile

Offen

#6.493 geöffnet am 27.07.2022

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (1 Reaktion) (0 zugewiesene Personen)Go (310 Forks)auto 404
area/ticdcgood first issuetype/feature

Repository-Metriken

Stars
 (461 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Lesen Sie den referenzierten Artikel und das Makefile, und fügen Sie für jedes Ziel Hilfe Kommentare gemäß dem beschriebenen Muster hinzu.
Tech Stack
go
Domain
documentationbuild system
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitMake
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85