Readme 与规范分开
作者: JAForbes创建于 2016年9月27日更新于 2021年4月12日
我在开发 Mithril、Lodash 和 Rx 以支持 Fantasy Land 过程中收到了许多开发者的反馈,他们对规范中使用的高深语言感到很生畏,并认为这不会对他们的工作有帮助。 我个人认为在规范中使用精确的语言是完全正确的做法。 但我认为在首页上解释库是什么、有什么好处、谁在使用它、如何开始实现它、相关项目等,会有很大帮助。 我收到了许多非功能性程序员的反馈,他们说我写的博客文章帮助他们看到了价值,然后他们开始在自己的库中实现 FL,加入 gitter 等。 我认为这非常棒! 我相信如果我们建立一个良好的平滑过渡,就能取得很大的成就。 所以我建议单独创建 `readme.md` 和 `spec.md`。 当前的 readme 将成为规范,而新的 readme 将是一份歌颂 Fantasy Land 等的文档。 readme 将更加通俗易懂(但仍然尽可能精确),更多地关注“如何”和“为什么”,而不是“什么”。
内容来源: fantasyland/fantasy-land