欢迎加入BoostKit社区,通过社区合作,基于硬件、基础软件和应用软件的全栈优化,提供基础加速软件包和应用加速软件包,使能应用极致性能,共同繁荣ARM硬件应用生态。
1. 体验BoostKit开源项目
- KVecTurbo:向量检索加速组件源码仓。
该源码仓当前提供了鲲鹏亲和的向量检索加速组件,支持对接openGauss向量数据库使用。通过将高维向量量化压缩与SIMD指令集加速距离计算,快速获取query的近邻。
- KNewPfordelta:PForDelta压缩算法优化源码仓。
该源码仓当前提供了鲲鹏基于开源PForDelta算法优化的一种专为高效压缩与快速解压倒排索引设计的整数压缩算法。
- Tensorflow:tensorflow优化源码仓。
该源码仓当前提供了针对搜推排序场景,基于鲲鹏处理器对开源tensorflow推理框架做性能优化特性扩展,通过算子融合、图优化、线程调度等技术加速推理性能。
2. 了解社区行为准则
在参与贡献前,请了解《BoostKit开源项目行为准则》,后续您在BoostKit开源项目的活动(包括但不限于发表评论、提交Issue、发表wiki等)都请遵循此行为准则。
3. 签署贡献者协议(CLA)
在参与项目贡献前,您需要签署BoostKit开源项目贡献者许可协议(CLA)。
请根据您的参与身份,选择签署个人CLA、企业CLA 或员工CLA,请点击这里签署。
个人CLA:以个人身份参与社区,请签署个人CLA。
企业CLA:以企业身份参与社区,请签署企业CLA。
员工CLA:以企业员工的身份参与社区,请签署员工CLA。
4. 参与贡献
在签署了CLA协议、找到了你想参与的开源项目后,就可以开始您的贡献之旅啦!
贡献的方式有很多种,每一种贡献都将受到欢迎和重视。
4.1 提交Issue/处理Issue任务
在这里,Issue 是用来记录和追踪开发者的想法、反馈、任务和缺陷。因此,通过 Issue 参与自己感兴趣的 SIG 或项目,是比较便捷的参与社区贡献方式之一。常见的 Issue 场景有:
(1) 报告 bug
(2) 提交建议
(3) 记录一个待完成任务
(4) 指出文档缺失/安装问题
(5) 答疑交流
找到Issue列表
在您感兴趣的BoostKit开源项目GitCode 主页内,点击“Issues”,即可找到 Issue 列表。如(BoostKit/BoostKit-community的issue列表)
-
提交Issue
如果您准备向社区上报Bug或者提交需求,或者为社区贡献自己的意见或建议,请在BoostKit开源项目对应的仓库上提交Issue。
提交Issue请参考 Issue 提交指南。
-
参与Issue讨论
每个Issue下面都支持开发者们交流讨论,如果您感兴趣,可以在评论区中发表自己的意见。
找到愿意处理的Issue
如果您愿意处理其中的一个Issue,可以将它分配给自己。只需要在评论框内输入“/assign”或 “/assign @yourself”,机器人就会将问题分配给您,您的名字将显示在负责人列表里。
4.2 贡献编码
-
准备BoostKit开发环境
-
了解BoostKit开源项目内的开发注意事项
-
代码下载与贡献流程
如果您想参与编码贡献,需要准备BoostKit开发环境,请参考每个开源项目的README.md,了解环境准备。
每个BoostKit开源项目使用的编码语言、开发编译环境等都可能存在差异,请参考每个开源项目中的README.md,了解编码贡献的一些要求。
(1) 进行代码开发前,请先将需要参与开发的仓库fork到个人仓,然后将个人仓下载到本地。并在本地分支进行代码修改。
(2) 参考每个开源项目的说明文档,进行本地构建与验证。
(3) 代码验证满足贡献要求后,提交Pull-Request,将代码贡献到相应的开源项目。
(4) 请注意查看门禁测试结果,若未通过,请根据问题提示进行本地代码修改;若通过,此PR会被分配给committer检视,请关注committer的检视意见。
(5) 当您的PR检视通过后,代码会合入相应的开源项目。
关于GitCode工作流的详细操作可参见GitCode工作流说明。
当您在提交PR过程中遇到问题,常见问题的解决方法可参见FAQs。
5. 加入SIG组一起成长
SIG 是 Special Interest Group 的缩写,BoostKit的开源项目以SIG的形式运作,以便于更好的管理和改善工作流程。SIG 组均是开放的,欢迎任何人来参与。
-
SIG都是针对特定的一个或多个技术主题而成立的。SIG的核心成员主导SIG的治理,SIG内的成员推动交付成果输出,并争取让交付成果成为社区发行的一部分。
-
每一个SIG会拥有一个或多个Repository,SIG的交付成果会保存在这些Repository内。您可以在SIG对应的Repository内提交Issue、针对特定问题参与讨论,提交和解决问题,参与评审等。
-
请访问这里了解更多SIG信息。