saveourtool/save-cli

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

Open

#492 opened on Feb 15, 2023

View on GitHub
 (0 comments) (0 reactions) (2 assignees)Kotlin (4 forks)auto 404
documentationhelp wantedinfrastructurerefactoringtests

Repository metrics

Stars
 (43 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Review the existing examples directory and readme files, then add new examples for different configurations as described in the linked issues.
Tech stack
kotlin
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80