非常高兴您有兴趣参与贡献OSSA项目,在开始之前,请阅读以下贡献指引。
本项目使用了pnpm,请确保已在全局安装
-
Fork这个仓库,并将你账户下的仓库clone到本地。
-
创建一个新的分支
git checkout -b {BRANCH_NAME}
-
在根目录下执行
pnpm start
-
在packages/ossa目录下进行您的创作
-
注意:需要在全局安装 @tarojs/cli
npm install @tarojs/cli -g
-
在根目录下编译更改之后ossa-ui
pnpm build
-
在packages/ossa-demo中预览您的更改
如果涉及到API变动,请对ossa-demo中相关的说明文档进行更新
pnpm dev:demo
-
执行自动化测试,保证更改不会影响其他功能
pnpm test
-
描述您的更新
pnpm changeset // 根据命令行提示,描述您这次更改
OSSA遵从 Angular Style Commit Message Conventions,在输入 commit message 的时候请务必遵从此规范。
- 务必保证
pnpm build
能够编译成功; - 务必保证提交的代码遵循相关包中的
.eslintrc
,.tslintrc
,.stylelintrc
所规定的规范; - 当相关包的
package.json
含有npm test
命令时,必须保证所有测试用例都需要通过; - 当相关包有测试用例时,请给你提交的代码也添加相应的测试用例;
- 提交代码 commit 时,commit 信息需要遵循 Angular Style Commit Message Conventions。
- 如果提交的代码非常多或功能复杂,可以把 PR 分成几个 commit 一起提交。我们在合并时会根据情况 squash。