-
Notifications
You must be signed in to change notification settings - Fork 17
怎样贡献代码
Xu,Yizhi edited this page Feb 12, 2015
·
16 revisions
这篇文章将描述我们大家一起如何完善lark.js框架的机制。
贡献代码前需要先了解git工具的使用和github网站的使用。
- git 工具用法可以查看git官方书籍,至少阅读：第一，第二，第三，第五，共4章，即可入门。
- github 网站使用可以查看中文版的github书籍, 或者看这个简单版 简单版2
不管你是修复lark.js的bug还是新增lark.js的功能，在你提交代码之前，在lark.js的github上提交一个 issue, 描述你要修复的问题或者要增加的功能。这么做有几个好处：
- lark.js的维护人员会对你提的bug或者新增功能进行相关讨论，确定该修改是不是必要，有没有提升的空间或更好的办法。
- 在达成一致后再提交代码，减少双方沟通成本，也减少pull request被拒绝的情况。
要修改或新增功能，在提issue后，点击左上角的fork按钮，复制一份lark.js主干代码到你的代码仓库。
（如果你是lark.js github维护人员,有lark.js在github上的权限，那么你要贡献代码时可以直接拉取主干最新代码。）
lark.js 所有修改都在分支上进行，修改完后提交 pull request ， 在code review 后由项目维护人员 merge 到主干。
因此，在获取源码步骤介绍后，你需要：
- 下载代码到本地
git clone https://github.com/你的仓库名/lark.git
- 拉分支准备修改代码
git branch update_xxx_feature
lark.js 通过 jshint 保持代码风格的一致。首先你要安装jshint工具。
sudo npm install -g jshint
在你修改完代码后，准备提交代码之前，运行
jshint .
jshint 会自动检查代码风格是否符合要求，并对不符合要求的代码进行提示。你安装提示修改完代码，直到不再有错误提示。这时候你的代码就符合lark.js约定俗成的代码风格了。