lchtangen/SampleMind-AI---Beta

Improve CLI help messages

Open

#2 opened on Oct 4, 2025

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Python (2 forks)auto 404
beginnercligood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (No merged PRs in 30d)

Description

Description: Make help messages more descriptive and user-friendly.

Tasks:

  • Add examples to command descriptions
  • Include expected input formats
  • Clarify what each option does

File: src/samplemind/interfaces/cli/menu.py

Difficulty: 🟢 Beginner Time: 1 hour

See docs/GOOD_FIRST_ISSUES.md Issue #2 for details.

Contributor guide

Research direction
Review the existing help messages in `src/samplemind/interfaces/cli/menu.py` and enhance them by adding usage examples, expected input formats, and clearer explanations for each option.
Tech stack
python
Domain
tooling
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80