gcanti/tcomb

Improve documentation

Open

#165 geöffnet am 6. Jan. 2016

Auf GitHub ansehen
 (6 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (1.899 Stars) (140 Forks)batch import
docshelp wanted

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
basic JavaScriptfamiliarity with tcomb
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
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.