aztfmod/rover

Implement the help command

Open

#59 opened on Jul 23, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Shell (148 forks)auto 404
good first issuehelp wanted

Repository metrics

Stars
 (176 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Study the existing implementation of the help for the clone command. Understand the pattern used to display help, examples, and detailed explanations. Extend that pattern to other commands like landingzone and global help. Also handle cases where missing values trigger help display.
Tech stack
shell
Domain
clidevops
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitShell scripting
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80