indiana91 / indiana91/devstandup

Improve CLI Help Text and Examples

Open
#5 2 comments 0 reactions 1 assignee View on GitHub

@yashksaini-coder is already working on this.

Since Oct 3, 2025.

documentation good first issue hacktoberfest
Dominant language
No language data
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.