现代前端库开发指南系列(三):从说明文档看库的前世今生

作者: 日期:2019-12-19

假如你觉得保护 CHANGELOG.md 比较困难,那么其实也有东西能够从库每次的 commit message 中剖析生成 CHANGELOG.md ,但这对 commit message 的规范性有必定要求,本系列后续的文章里会有具体的介绍。

LICENSE 是本库的版权声明,声明用户能够在什么范围内运用、二次开发、商用本库,具有法律效力,一般能够直接声明运用现成的协议,如 GPL / BSD / MIT/ Mozilla / Apache / LGPL 等,本文不计划介绍怎么挑选适宜的协议,可参阅《怎么挑选开源许可证?》。

LICENSE 关于商业项目的技能选型有这一票否定的位置,由于某些开源协议具有传染性,若你的项目运用了这样的开源库,则你的项目也有必要开源,这关于商业项目来说几乎是不行承受的。

干流前端结构 React ,就曾因 LICENSE 问题,引发社区强烈不满,并遭到不少大型公司弃用,终究迫于压力下才改用最宽松的 MIT 协议,这才停息了风云。

请正确评价你所开发的库的用户集体,假如库的用户集体中包含他国人员,请为他们预备好适宜言语的阐明文档。而关于一个把源码保管在公共代码库房的开源项目来说,我主张至少预备中英文两套阐明文档,这将大大扩展开源库的用户群,究竟已然辛辛苦苦做出来个开源库,总仍是想多收成点 Star 和 Fork 的嘛嘿嘿~~

一般咱们将默许一个阐明文档是运用英语的,而把运用其它言语的阐明文档的文件名上加上 IETF 言语代码,如简体中文的 IETF 言语代码是zh-CN,因而 README.md 的中文文档命名是README.zh-CN.md, CHANGELOG.md 的中文文档命名是CHANGELOG.zh-CN.md,而 LICENSE 则只需要一份英文版的就足够了。

我会以我最近写的两个开源库:javascript-library-boilerplate 和 vue-directive-window 来作为实例项目代码来辅佐介绍。

javascript-library-boilerplate 是一个现代前端生态下快速构建 javascript 库的脚手架,本库支撑 GitHub 的 repository templates 功用,你能够直接在项目主页点击 Use this template 来直接套用本脚手架的代码来创立你自己的 javascript 库。

vue-directive-window 是一个能够快速让模态框支撑类窗口操作的增强库;类窗口操作首要包含三大类:拖拽移动、拖拽调整窗口尺度、窗口最大化; vue-directive-window 支撑以 Vue 自定义指令或是一般 js 类的方法来调用。

vue-directive-window 相关于 javascript-library-boilerplate 来说,更靠近 Vue 生态圈,假如你最近想为 Vue 生态圈添砖加瓦,无妨参阅一下本项目。

首页
电话
短信
联系