saveourtool/save-cli

[Help wanted] Enhance documentation with more examples of execution of `save-cli` with different initial configurations

Open

#492 aberto em 15 de fev. de 2023

Ver no GitHub
 (0 comments) (0 reactions) (2 assignees)Kotlin (4 forks)auto 404
documentationhelp wantedinfrastructurerefactoringtests

Métricas do repositório

Stars
 (43 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

For now we have a very pure information about general process of execution of some examples and its configuration

We have an directory with examples examples/kotlin-diktat, but it's not fully covered by readme's For any new user it's very uncomfortable to understand what's going on and how to execute save-cli with certain settings

Related:

Probably related

Guia do colaborador

Direção de pesquisa
Revise o diretório de exemplos existentes e os arquivos readme, depois adicione novos exemplos para diferentes configurações conforme descrito nas issues vinculadas.
Pilha de tecnologia
kotlin
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80