aztfmod/rover

Implement the help command

Aberta

#59 aberto em 23 de jul. de 2020

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)Shell (148 forks)auto 404
good first issuehelp wanted

Métricas do repositório

Stars
 (176 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Estude a implementação existente da ajuda para o comando clone. Entenda o padrão usado para exibir ajuda, exemplos e explicações detalhadas. Estenda esse padrão para outros comandos como landingzone e help global. Também lide com casos em que a falta de um valor aciona a exibição de ajuda.
Pilha de tecnologia
shell
Domain
clidevops
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitShell scripting
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80