怎样贡献代码

这篇文章将描述我们大家一起如何完善lark.js框架的机制。

准备工作

贡献代码前需要先了解git工具的使用和github网站的使用。

• git 工具用法可以查看git官方书籍,至少阅读：第一，第二，第三，第五，共4章，即可入门。
• github 网站使用可以查看中文版的github书籍, 或者看这个简单版

不管你是修复lark.js的bug还是新增lark.js的功能，在你提交代码之前，在lark.js的github上提交一个 issue, 描述你要修复的问题或者要增加的功能。lark.js的维护人员会和你进行相关讨论。

github 贡献代码流程

获取源码

拉分支

修改代码提交

提交回主干代码

修改代码注意事项

代码风格保持一致

lark.js 通过 jshint 保持代码风格的一致。首先你要安装jshint工具。

sudo npm install -g jshint

在你修改完代码后，准备提交代码之前，运行

jshint .

jshint 会自动检查代码风格是否符合要求，并对不符合要求的代码进行提示。你安装提示修改完代码，直到不再有错误提示。这时候你的代码就符合lark.js约定俗成的代码风格了。

补充单元测试代码

代码修改完后进行性能测试