indiana91/devstandup

Improve CLI Help Text and Examples

開放

#5 建立於 2025年10月2日

 (2 則留言) (0 個反應) (1 位負責人) (0 個分叉)auto 404
documentationgood first issuehacktoberfest

倉庫指標

星標
 (1 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

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

貢獻者指南