第一章 总则¶
第一条 制定依据 本章程依据《量潮科技基本章程》制定,旨在建立公司代码交付与审核的标准化规则,确保代码质量可控、交付流程规范。
第二条 目的 为规范代码交付行为,降低因低质量交付导致的审核成本与返工成本,建立可量化的交付标准,特制定本章程。
第三条 适用范围 本章程适用于公司所有基于 Git 仓库的代码交付活动,包括新功能开发、Bug 修复、重构、文档更新等。
第二章 仓库结构¶
第四条 目录结构
项目仓库的文件必须归入以下指定目录,不得在根目录随意堆积:
data/ 所有数据文件
docs/ 所有文档
scripts/ 辅助脚本
src/ 单应用源代码(与 apps/ 二选一)
apps/ 多应用子模块(与 src/ 二选一)
tests/ 单元测试
integrated_tests/ 集成测试
manifests/ 部署清单第五条 特殊文件
项目仓库应包含以下文件:
(一)README.md — 项目说明;
(二)AGENTS.md — 记录业务意图、关键决策和管道逻辑,作为项目的上下文入口;
(三)CHANGELOG.md — 遵循 Keep a Changelog 规范,版本号遵循 SemVer;
(四).gitignore — 至少覆盖以下类型:
构建产物:
__pycache__/、*.pyc、node_modules/、target/、build/、dist/IDE 配置:
.idea/、.vscode/(团队共享配置除外)系统文件:
.DS_Store、Thumbs.dbOffice 临时文件:
~$*.docx数据库文件:
*.db、*.sqlite
第三章 交付标准¶
第六条 交付体量控制 单次 Pull Request 的交付体量应遵循以下标准:
(一)原则上单个 PR 涉及的文件不超过 20 个; (二)超过 20 个文件的 PR,须在描述中说明原因; (三)一个 PR 只完成一个功能目标,不应混合多个独立功能。
第七条 PR 描述规范 PR 描述必须包含以下内容:
(一)本次改动的目的与背景; (二)改动内容摘要; (三)验证方式:如何确认改动正确(如测试命令、截图等)。
第四章 审核与验收¶
第八条 审核流程 代码交付须经以下审核流程:
(一)提交者完成自测,确保本地测试通过; (二)提交 Pull Request,附上符合第七条要求的描述; (三)审核人员对代码进行评审; (四)审核通过后合并,审核不通过则退回修改。
第九条 审核标准 审核人员应重点检查以下方面:
(一)是否符合第三章规定的交付标准; (二)是否符合第二章规定的仓库结构规范; (三)代码逻辑正确性; (四)是否存在明显的安全或性能问题; (五)是否包含测试覆盖。
第十条 验收通过条件 Pull Request 通过验收须同时满足以下条件:
(一)不含任何构建产物; (二)交付体量符合第六条规定; (三)PR 描述符合第七条规定; (四)仓库结构符合第四至五条规定; (五)审核人员确认代码逻辑正确; (六)本地测试通过。
不符合前款规定任意一项的,审核人员有权直接关闭 PR。
第五章 附则¶
第十一条 章程效力 本章程经公司治理机构审议通过,自发布之日起生效。
第十二条 解释权 本章程之解释,应遵循质量优先之基本原则。各项条文不得被解释为阻碍合理的代码提交或降低交付效率。