saveourtool/save-cli

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

Open

#492 ouverte le 15 févr. 2023

Voir sur GitHub
 (0 commentaires) (0 réactions) (2 assignés)Kotlin (4 forks)auto 404
documentationhelp wantedinfrastructurerefactoringtests

Métriques du dépôt

Stars
 (43 stars)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Examinez le répertoire d'exemples existant et les fichiers readme, puis ajoutez de nouveaux exemples pour différentes configurations comme décrit dans les problèmes liés.
Stack technique
kotlin
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80