gcanti/tcomb

Improve documentation

Open

#165 建立於 2016年1月6日

在 GitHub 查看
 (6 留言) (0 反應) (0 負責人)JavaScript (1,899 star) (140 fork)batch import
docshelp wanted

描述

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

貢獻者指南

技術棧
javascript
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic JavaScriptfamiliarity with tcomb
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
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.