从零做一个前端开源项目
开源除了源代码意外事件还包含下面:
(1)源码
(2)文档
(3)开发环境
(4)允许其他人贡献代码
(5)用户问题
(6)问题列表(记录当前问题)和升级计划
为什么做开源?
(1)全面提高编程能力
(2)提高自己社区知名度
(3)锻炼产品意识
(4)技术范儿
怎么做?
(1)去github和npm分别注册账号
(2)创建项目
(3)添加 SSH KEY
ssh key 就是连接你的电脑和 github 服务器的一把钥匙,只有添加成功了才能把你本地的代码提交到 github 服务器。
如果你是 mac os 系统,运行 ssh-keygen 即可一步一步生成 ssh key ,然后运行 pbcopy < ~/.ssh/id_rsa.pub 即可拷贝下来,等着粘贴。
搭建开发环境
初始化
进入项目目录,然后命令行运行 npm init ,按照提示进行初始化即可。提示中的信息,能写的都写上,别随意忽略了。初始化完成之后,项目根目录下会有 package.json 的文件。
规范版本号
打开 package.json 文件,将版本号定义为 "version": "0.0.1" 。以后我们每次正式提交代码,版本号都不一样。版本号分三级,分别为:
一级,重构版本
二级,重大功能改进
三级,小升级或者 bug 修复
为何从 0.0.1 开始?因为 0.x.x 可以认为是非正式版本、测试版,而从 1.x.x 开始,就是正式发布的版本了。
规范一级目录
src - 源代码
release - 发布结果
test - 单元测试用例
doc - 文档
example - 示例