MerginMaps / MerginMaps/python-api-client
Add example to the command lines
Aberta
Ninguém assumiu esta issue ainda.
enhancement
good first issue
- Linguagem predominante
- Python
- Estrelas
- 23
- Forks
- 12
- Merge médio
- 2d 13h
- PRs com merge (30d)
- 7
Descrição
I am struggling to use most of the command lines reading the help files. Like most terminal commands, I prefer to look at examples!
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece revisando os arquivos de ajuda da linha de comando e identificando quais comandos não têm exemplos de uso. Adicione exemplos práticos para os comandos abrangidos pela solicitação e, em seguida, verifique se a saída da ajuda mostra claramente como cada comando é usado.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- cli, documentation
- Tipo de issue
- Documentação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Estagnada
- Clareza
- Precisa de esclarecimento
- Facilidade para iniciantes
- 30/100