pingcap/tiflow

Add help docs for makefile

Open

#6,493 opened on Jul 27, 2022

View on GitHubContributor guide
 (1 comment) (1 reaction) (0 assignees)Go (310 forks)auto 404
area/ticdcgood first issuetype/feature

Repository metrics

Stars
 (461 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Read the referenced article and the Makefile to add help comments for each target following the pattern described.
Tech stack
go
Domain
documentationbuild system
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMake
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85