saveourtool/save-cli

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

Open

#492 geöffnet am 15. Feb. 2023

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (2 zugewiesene Personen)Kotlin (4 Forks)auto 404
documentationhelp wantedinfrastructurerefactoringtests

Repository-Metriken

Stars
 (43 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Überprüfe das vorhandene Beispiele Verzeichnis und die README Dateien und füge dann neue Beispiele für verschiedene Konfigurationen hinzu, wie in den verknüpften Issues beschrieben.
Tech Stack
kotlin
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80