Skip to content

Latest commit

 

History

History
executable file
·
52 lines (27 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
52 lines (27 loc) · 1.46 KB

如何给bui贡献组件

bui从1.1.0之后将bui从一个大整体拆分成各细粒度的小项目,每个项目都是一个独立完成的组件,基于bui的组件开发也变得非常的便捷。

1. 如何开发一个组件

bui的组件是基于spm3来进行管理和组织的,所以在开始前,最好能先稍微了解下spm3

1. 准备

  1. 安装spm3

    npm install spm -g
    
  2. 通过spm初始化一个项目

    mkdir bui-test
    cd bui-test
    spm init
    

2. 组件开发

按标准的spm模块开发流程来,并要完成单测, demo, api

3. 发布到spm源

在spm test都跑过之后,执行spm publish发布到spm源,这样一个组件的开发就算是完成了

4. 告诉我们你的组件

issues里同新建一条,告诉我们你的组件

5. 其他要注意的事项

  1. spm默认会忽略dist目录,我们发到源上的包是需要dist目录的,所以要去掉.spmignore里面dist这一行
  2. 如果存在多个js文件,请将除入口文件之外的其他js放到src目录下面来
  3. 在spm里面添加:"buildArgs": "--ignore jquery",来忽略jquery的版本

2. 使用新的组件

  1. 在我们处理完你提issues之后,就可以从master上重新pull一下,你就会发现在dist目录里面多了一个你写的这个