vitessio/vitess

Rewrite `flagutil.OptionalFlag` to use generics

Closed

#11,154 opened on Sep 1, 2022

View on GitHubContributor guide
 (8 comments) (0 reactions) (1 assignee)Go (2,384 forks)batch import
Component: CLIType: Internal Cleanupgood first issue

Repository metrics

Stars
 (21,222 stars)
PR merge metrics
 (Avg merge 3d 21h) (134 merged PRs in 30d)

Description

Now that we have generics, we can stop hand-writing each implementation of flagutil.OptionalFlag for each type we want, instead writing a generic OptionalFlag over any type T, providing a parsing function that has the signature func(string) (T, error)

Contributor guide

Research direction
Study the existing OptionalFlag implementations for each type, then design a generic version using Go generics with a parsing function signature func(string) (T, error).
Tech stack
go
Domain
backend
Issue type
Refactor
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.
Half day
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
GoGenerics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70