贡献指南
本指南面向希望参与 Hi-AIoT-Solution 项目的开发者,介绍文档贡献与代码贡献的完整流程与规范。
文档贡献
欢迎通过以下三种方式参与文档贡献。提交的内容、图片必须为原创,不得侵犯他人知识产权。
简单更改
适用于少量内容修改和补充:
- 本地新建分支,修改对应的
*.md文件 - 遵循提交信息规范提交修改,并推送到 GitCode 仓库
- 在仓库页面单击「新建 Pull Request」,选择刚推送的分支
- 按提交合并请求规范填写合并请求信息
- 文档维护团队评审,所有讨论解决后合并到 master 分支
反馈问题
在仓库 Issue 页签单击「新建 Issue」,标题描述问题,正文补充详细说明。
高质量问题反馈建议:
- 清晰指出缺失、过时或错误的内容
- 说明该问题对使用者的影响
- 将问题范围限定在一个具体内容上,如「XX开发指南缺少对XXX步骤的介绍」,而非「文档需要优化」
- 提交前搜索已有 Issue,避免重复提交
创建新内容
若要创建或修改文档,请先阅读 文档规范,并按内容类型选用对应模板:
- 应用案例:参见 案例 README 模板
- 智能体 Skill:参见 Skill README 模板
- 组件接口说明:参见 组件接口使用文档模板
提交信息规范
每条提交须附带说明消息,消息第一行格式:
- 以改动内容所属类别开头(如
artificial-intelligence:) - 示例:
artificial-intelligence: bs21e support sle_measure_dis. - 更详细的变更原因写在第一行之后的正文中,说明「为什么」发生变更,方便日后阅读提交日志
提交合并请求规范
- Title:格式为
add: 简要描述 - Description:分点描述该合并修改的信息,示例:
1. add bs21e support sle_measure_dis. - 分支规则:修改在本地新建分支上进行,不直接在 master 分支改动;分支推送后通过 Pull Request 合并回 master
- 评审:所有讨论(评论)解决且 Pull Request 成功提交后,修改流程即告完成
代码贡献
代码贡献流程与文档贡献一致:本地新建分支 → 修改 → 按提交信息规范提交 → 新建 Pull Request → 评审合并。
涉及第三方开源软件的引入,请遵循 添加第三方开源组件 完成构建集成与合规登记。
相关文档
| 文档 | 说明 |
|---|---|
| 文档规范 | 项目文档写作的基本要求 |
| 案例 README 模板 | 应用案例 README 的结构模板 |
| Skill README 模板 | AI Skill 的 README 的结构模板 |
| 组件接口使用文档模板 | 组件接口说明文档的结构模板 |
| 添加第三方开源组件 | 第三方开源软件引入流程与合规登记 |