gcanti/tcomb

Improve documentation

Open

#165 aberto em 6 de jan. de 2016

Ver no 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

Guia do colaborador

Pilha de tecnologia
javascript
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
basic JavaScriptfamiliarity with tcomb
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60
Direção de pesquisa
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.