indiana91/devstandup

Improve CLI Help Text and Examples

Aperta

#5 aperta il 2 ott 2025

Vedi su GitHubGuida contributor
 (2 commenti) (0 reazioni) (1 assegnatario) (0 fork)auto 404
documentationgood first issuehacktoberfest

Metriche repository

Star
 (1 stella)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Guarda il framework CLI utilizzato (probabilmente Cobra) e aggiungi una sezione ESEMPI alla descrizione Long di ogni comando. Usa lipgloss per l'output colorato.
Tech stack
go
Dominio
cli
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85