-
Notifications
You must be signed in to change notification settings - Fork 623
CONTRIBUTING
大果 edited this page Apr 21, 2021
·
1 revision
Rax 从诞生的第一天起就拥抱开源,也希望更多的开发者可以给我们贡献代码。基于这个背景,我们希望可以通过这篇文档帮助开发者更好的给 Rax 体系产品贡献代码。
Rax 体系主要分为三层:
-
Rax Core:面向多端场景的渐进式轻量 React UI 库
-
Rax App 研发框架:面向无线多端场景领先、稳定的研发框架
- 工程构建能力:以 build scripts 作为工程构建的基础,分别通过
build-plugin-rax-web
/build-plugin-rax-miniapp
/build-plugin-rax-kraken
/build-plugin-rax-weex
支持构建出可以运行在各个容器的产物 - 运行时能力:提供了面向多端统一的运行时能力,比如生命周期、TabBar 方案等
- 更多关于小程序相关的框架能力参见,raxjs/miniapp
- 工程构建能力:以 build scripts 作为工程构建的基础,分别通过
-
Rax 生态:
- 组件元件:提供了可以运行在多端的基础组件集合
- Uni API:提供了小程序容器和 Web 容器的跨端 API 解决方案
一般来说,仓库 issue 列表中存在的 issue 都是对 bug 的反馈或者新功能的诉求。你可以根据自己对 Rax 代码的了解,针对这些 issue 进行讨论并通过 PR 提出自己的解决方案。
点击仓库左上角的「Fork」按钮将仓库复制到你自己的仓库列表。
将复制到你的自身仓库列表的仓库通过 git clone
复制到本地,然后从 master
分支通过 git checkout -b 分支名
创建你的分支。
注意: 每次提交代码前,尽可能保证本地的代码已经同步过 Rax 目标仓库最新的代码。
- 新特性:
feat/
+ 特性简述 - 修复问题:
hotfix/
+ 问题简述 - 重构:
refactor/
+ 重构内容 - 代码优化或其它修改:
chore/
+ 修改内容 - 某个包发布:
release/包名-版本号
- 统一发布:
release-next
- feat (新的特性)
- fix (修复已知问题)
- perf (性能优化)
- refactor (代码重构)
- test (补充测试用例)
- build (仓库自身构建相关变动)
- ci (仓库 CI 流程修改)
- chore (对功能表现没有任何影响的修改)
- revert (还原上一次的 commit)
我们在 Review 代码的时候,会对所有的 commit 信息进行 Review,如果不符合标准会拒绝合并对应的 PR,
在提交 PR 前,尽可能详细的描述 PR 主要做了什么事情,以及可以通过关联 issue 的方式介绍相关的背景。如果是功能性的修改,请提供示例 DEMO,方便其他人更容易看出来在做什么。
所有的代码修改必须通过仓库的 lint
规则;功能性的代码修改,必须通过仓库的单元测试,新增的能力必须添加对应的测试用例。