saveourtool/save-cli

Provide an exhaustive documentation for `examples` directory

Open

#496 opened on Feb 15, 2023

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Kotlin (4 forks)auto 404
documentationhelp wanted

Repository metrics

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

Description

All cases, or most of them should be documented

Contributor guide

Research direction
Review the existing example files in the `examples` directory and document each one, including purpose, usage, and expected output.
Tech stack
kotlin
Domain
cli
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.
Fresh
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