lchtangen / lchtangen/SampleMind-AI---Beta
Improve CLI help messages
Open
Nobody has claimed this yet.
beginner
cli
good first issue
- Dominant language
- Python
- Stars
- 1
- Forks
- 1
- 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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read src/samplemind/interfaces/cli/menu.py to find the existing command descriptions and option help text. Update the messages with examples, expected input formats, and clearer option explanations; done means each CLI command and option has more descriptive, user-friendly help.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100