gcanti/tcomb

Improve documentation

Open

#165 opened on Jan 6, 2016

View on GitHub
 (6 comments) (0 reactions) (0 assignees)JavaScript (140 forks)batch import
docshelp wanted

Repository metrics

Stars
 (1,899 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I'm writing "A little guide to runtime type checking and runtime type introspection" https://github.com/gcanti/tcomb/blob/master/docs/GUIDE.md. It's an attempt to write down how I use tcomb in my own projects, hope it's helpful to others. Any comment, suggestion or review is welcome.

Cheers, Giulio

Contributor guide

Research direction
Review the existing guide and identify areas for improvement, such as adding more examples or clarifying concepts.
Tech stack
javascript
Domain
developer experience
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80