为Ascend RAGSDK贡献

感谢您考虑为 Ascend RAGSDK 做出贡献！我们欢迎任何形式的贡献，包括错误修复、功能增强、文档改进等，甚至只是反馈。无论您是经验丰富的开发者还是第一次参与开源项目，您的帮助都是非常宝贵的。

您可以通过多种方式支持本项目：

• 领取任务奖励：昇腾开源软件社区任务
• 贡献前，请先签署开放项目贡献者许可协议CLA。
• 审查Pull Request并协助其他贡献者。
• 传播项目：在博客文章、社交媒体上分享RAGSDK，或给仓库点个⭐。

请先提前了解社区相关规范：

• Ascend开源项目行为守则
• Issue提交指南
• Issue处理流程说明
• Ascend社区开发者测试贡献指南
• Ascend开源与第三方软件建仓及分支命名指导
• Ascend开源与第三方软件管理规范
• 社区安全设计规范
• 代码规范
• PR提交指南

开发与测试

1. Fork仓库：在GitCode平台代码仓库右上角点击"Fork"按钮，Fork一份源代码到个人仓

2. 克隆到本地：

   将Fork到个人仓的代码克隆到本地进行代码开发

   git clone https://gitcode.com/<your-username>/RAGSDK.git
   

3. 创建开发分支：

   git checkout -b {new_branch_name} origin/master
   

4. 代码开发：

   • 代码开发规范请遵循代码开发规范。
   • 代码安全规范请遵循代码安全规范。

5. 开发构建验证：

   ① 从 AscendHub 下载 RAGSDK 镜像，运行容器。

   ② 在容器中克隆仓库：

   git clone https://gitcode.com/Ascend/RAGSDK.git
   cd RAGSDK
   

   ③ 本地代码开发完成后，进入 build 子目录，执行构建脚本：

   cd build
   bash build.sh
   

   ④ 构建完成后，进行软件包安装：

   cd ./output/
   pip3 uninstall mx_rag
   pip3 install mx_rag*.whl
   

   ⑤ 本地执行UT和补充UT，参见RAG SDK测试指南

6. 执行pre-commit检查

   本地提交代码前请先执行pre-commit检查，检查指导参见pre-commit本地运行指南。

7. 提交Pull Request

   提交PR并等待代码审查。

8. 社区评审

   如果涉及patch、头文件宏、API接口等更新，需提交社区在SIG例会进行评审，社区定期例会与活动参见会议日历。