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

贡献者指南