代码提交规范（训练-试行版）

使用场景指导

开发前确保已了解下文PR及Commits要求中的内容；
第一个PR提交开源模型原始代码，可删除不必要的文件（如图片、模型数据集、权重等），CI门禁codecheck遵循代码最小化改动原则可不做处理，申请屏蔽；
第二个PR提交NPU适配相关代码，涉及修改的文件需要添加合适的Copyright License，如模型代码需要撰写公网地址声明，需在该PR中作为一个独立的commit一齐提交，具体规范参考附录公网地址声明规范；
原则上不允许引入三方库源码，涉及三方库源码修改，建议通过bugfix方式在模型侧适配；
模型README需按统一模板要求撰写；

原始开源代码遵循最小化改动原则，新增适配部分需遵循内部编码规范；

PR标题应简洁完备，描述清晰，无效信息将不允许合入，如“修改配置文件”、“First commit”等；
PR正文应按提交模板准确填写，说明PR的目的、改动点、自测结果（可选），完成自检checklist勾选，无效信息将不允许合入，如保持空白、保持默认模板、自检checklist未勾选等；
确保每一次commit对应的commit message清晰描述提交代码的功能，无效信息将不允许合入，如“添加适配文件”、“修改README”等；
多余无效的commits需要压缩合并，如多个连续相同commit message、连续codecheck修改等；
单个PR尽量做到功能单一，代码量控制在500行内（特殊场景请在PR正文说明），commits次数原则上不应超过2次；
CI门禁codecheck整改、检视意见修改需随PR一并完成，不允许作为独立PR或独立commit提交；
PR提交人需关注对代码中的公网地址进行声明，具体要求见附录公网地址声明规范，同时确保CI门禁codecheck敏感词扫描申请屏蔽的公网地址与声明范围一致（误报场景除外）；
所有committer的检视意见需要有回复或标记已解决；
PR提交人完成自检，需确保CI门禁通过后启动代码检视（可通过评论“compile”触发CI门禁扫描）；

为避免出现用户界面不可见或产品资料未描述的公网地址，需对代码中的公网地址进行声明；

代码中包含的公网IP地址、公网URL地址/域名、邮箱地址，可基于CI门禁codecheck敏感词扫描结果整理；

公网地址在以下场景中，不强制要求声明：

文件名统一为public_address_statement.md，放置于对应模型根目录下；

文件内容格式示例如下：

类型	开源代码地址	文件名	公网IP地址/公网URL地址/域名/邮箱地址	用途说明
开源代码引入	https://xxx	xxx	https://xxx	代码注释中包含的issue链接
开发引入	不涉及	xxx	https://xxx	业务代码注释

各字段含义及要求：

类型：
- 开源代码引入：指该公网地址在原始开源项目中已存在；
- 开发引入：指NPU适配阶段引入的公网地址；
开源代码地址：
- 类型为“开源代码引入“时，填写该公网地址在原始开源项目中对应文件路径（标准URL链接，可直接访问至该文件）；
- 类型为“开发引入”时，填写“不涉及”；
文件名：该公网地址所在文件的相对路径（从模型仓根目录开始写，如Bert_Chinese_ID3433_for_PyTorch/url.ini）；
公网IP地址/公网URL地址/域名/邮箱地址：具体的公网地址内容；
用途说明：该公网地址在代码中的用途，如issue注释说明、日志提示等；

特别注意：

在模型README末尾添加章节，对public_address_statement.md文件进行声明，例如：

## 公网地址声明
本代码仓包含公网地址，公开性声明请参考public_address_statement.md文件。