aztfmod / aztfmod/rover

Implement the help command

Open
#59 0 comments 0 reactions 0 assignees View on GitHub
good first issue help wanted
Dominant language
Shell
Stars
176
Forks
147
PR merge metrics
No merged PRs in 30d

Description

There is an initial implementation to display the help for the rover --clone. This issue extends the implementation to the other commands available

Proposed approach:

rover --help to display all commands available
rover --clone --help to display the clone command
rover --landingzone -h or rover -lz --help to display the landingzone help command

When an a value is missing for a given attribute the rover displays the example and the detailed explanation of the attribute.
For example rover --clone-branch requires to set the name of the branch. The rover will fails and display the examples and the detailed explanation of the --clone-branch

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the existing rover --clone help implementation and inspect the entry points for the other commands named in the issue. Run the documented rover --help, rover --clone --help, and rover --landingzone -h or rover -lz --help flows. Done means each command shows the requested help, and missing values show their examples and detailed explanations.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.