gcanti/tcomb

Improve documentation

Open

#165 opened on Jan 6, 2016

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

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

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic JavaScriptfamiliarity with tcomb
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Read the existing GUIDE.md at https://github.com/gcanti/tcomb/blob/master/docs/GUIDE.md and review the tcomb library's runtime type checking features. The issue asks for a guide on how the author uses tcomb for runtime type checking and introspection. Focus on explaining the concepts with examples and code snippets. No specific files mentioned beyond GUIDE.md; ensure the guide is helpful and clearly structured.