indiana91/devstandup

Improve CLI Help Text and Examples

Offen

#5 geöffnet am 02.10.2025

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (0 Reaktionen) (1 zugewiesene Person) (0 Forks)auto 404
documentationgood first issuehacktoberfest

Repository-Metriken

Stars
 (1 Stern)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Enhance the CLI help output with more examples and better formatting.

Tasks:

  • Add usage examples to each command's Long description
  • Add "EXAMPLES" section showing common use cases
  • Improve flag descriptions to be more user-friendly
  • Add colorized output to help text using lipgloss
  • Add tips section for first-time users

Example:

EXAMPLES:
  # Generate standup for today
  $ devstandup

  # Generate for last week with specific author
  $ devstandup --since "7 days ago" --author "John Doe"

  # Export to markdown file
  $ devstandup --output standup.md

Acceptance Criteria:

  • Help text includes at least 5 practical examples
  • Flags have clear, beginner-friendly descriptions
  • Help output is well-formatted and easy to scan

Contributor Guide

Research-Richtung
Schaue dir das verwendete CLI Framework (wahrscheinlich Cobra) an und füge jedem Befehl einen BEISPIELE Abschnitt zur Langbeschreibung hinzu. Verwende lipgloss für farbige Ausgabe.
Tech Stack
go
Domain
cli
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
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85