gcanti/tcomb

Improve documentation

Open

#165 ouverte le 6 janv. 2016

Voir sur GitHub
 (6 commentaires) (0 réactions) (0 assignés)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

Guide contributeur

Stack technique
javascript
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
basic JavaScriptfamiliarity with tcomb
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60
Direction de recherche
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.