汽车行业技术部软件工程师代码编写规范手册.docxVIP

汽车行业技术部软件工程师代码编写规范手册

第1章项目结构与代码组织

1.1根目录与项目元数据规范

全局路径约定：所有文件必须位于项目根目录的`src/`子目录中，严禁直接放入`src/`根目录下的任意文件夹，除非该文件夹被明确定义为模块边界。核心文件标识：根目录下的`README.md`文件必须包含项目概述、技术栈清单、CI/CD流水线配置以及开发环境搭建指南，且版本号需与Git分支命名严格一致。

依赖管理标准化：`package.json`或`pom.xml`中必须明确列出所有运行时依赖，版本号需锁定在`latest`或指定小版本（如`2.1.0`），禁止使用`^`或`~`进行模糊匹配，以确保持久性兼容。构建脚本封装：`package.json`中的`scripts`字段必须定义至少`build`、`lint`、`test`三个核心命令，且`build`命令需包含`tsc`类型检查及`npmrunbuild`发布脚本。环境配置分离：`src/.env.example`文件需作为环境变量模板存在，其中必须包含`NODE_ENV=development`、`API_BASE_URL`及数据库连接字符串占位符，严禁在生产代码中硬编码密钥。

Git分支策略：代码提交前必须遵循`gitche