saveourtool/save-cli

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

Open

#492 aperta il 15 feb 2023

Vedi su GitHub
 (0 commenti) (0 reazioni) (2 assegnatari)Kotlin (4 fork)auto 404
documentationhelp wantedinfrastructurerefactoringtests

Metriche repository

Star
 (43 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina la directory degli esempi esistenti e i file readme, quindi aggiungi nuovi esempi per diverse configurazioni come descritto nei problemi collegati.
Tech stack
kotlin
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80