【金秋打卡】第九天 从零做一个前端开源项目

学习课程名称：从零做一个前端开源项目
章节名称：提交代码
讲师：双越

课程内容：提交代码

软件三要素：程序、数据，文档

写代码记得一定要使用编码规范的工具，例如eslint 等，否则经过长时间的维护，必然留坑。

写文档 & 写测试用例

注意，文档和测试用例对于一个开源产品来说非常重要！非常重要! 非常重要！而且，文档和测试用例本身就是代码不可分割的一部分。

在写文档之前，还需要准备其他的工具。定位到项目目录下， npm i gitbook-cli -g 安装gitbook,然后创建SUMMARY.md，其实一看这个文件内容就知道，这是一个文档的目录，你可以根据自己项目的需求重新定义这个目录。需要注意的是，第一行*【项目介绍】（README.md）对应的是已经存在的README.md文件。

运行gitbook init ,会看到各个文件都被创建了，就可以完善各个文档的内容了。内容完成之后，运行gitbook build 可以将md文件发布成为html文件，默认放在_book文件夹。启动了npm run example之后，可以访问http://127.0.0.1:8888/_book/查看效果。

提交第一版代码

首先，修改一下.gitignore文件，加上一行_book,把打包出来的文件忽略掉。然后用之前的方式提交到github的master分支。

git tag -a “v0.0.1” -m "第一版本"
git push origin v0.0.1

提交之后，下载地址就有了

最后要提交到 npm 上，能让使用者通过npm 进行安装。首先，运行 npm add user 和 npm login 登录，根据提示将你之前注册的npm的账号、密码、邮箱写上就行了，问题不大。然后，在项目的根目录运行npm publish .,此时问题来了！！！

运行之后报了403错误，刚才明明登录成功了，不可能有权限问题呀。后来一查才知道，原来发布的包名和npm中已有的项目名称重名了！！！没有办法，只能改名。

----