indiana91/devstandup

Improve CLI Help Text and Examples

オープン

#5 opened on 2025/10/02

 (2 件のコメント) (0 件のリアクション) (1 人の担当者) (0 件のフォーク)auto 404
documentationgood first issuehacktoberfest

Repository metrics

Stars
 (1 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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

コントリビューターガイド