mre/prettyprint

Add `examples` folder

Open

#10 opened on Apr 4, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (8 forks)github user discovery
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (201 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

There should be an examples folder for showing different features of the library. This would help people get up to speed quickly and show off some of the more interesting features of the library such as the soon to be added stderr support (#9).

If anyone wants to contribute a usage example, feel free to send a pull request. 😊

Contributor guide

Research direction
Read the library's existing documentation and source code to understand public API, then create a new 'examples' directory with simple usage examples covering basic output and stderr support (see issue #9).
Tech stack
rust
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
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80