互联网行业研发部工程师代码编写工作手册.docxVIP

互联网行业研发部工程师代码编写工作手册

第1章工程规范与代码风格

1.1项目初始化与基础配置

在开始任何开发工作前，必须首先创建并初始化Git仓库，将项目根目录下的配置文件（如`package.json`,`pom.xml`,`Cargo.toml`）和配置文件（如`tsconfig.json`,`vite.config.ts`）提交至远程仓库，确保版本控制从初始化阶段就建立完整的历史记录。必须配置`.gitignore`文件，明确排除开发环境依赖（如`node_modules`,`.env`,`npm-debug.log`）、操作系统缓存及构建产物，防止敏感信息泄露并优化仓库体积。

项目根目录下必须建立`.github/workflows`目录，通过YAML格式的YAML配置文件定义CI/CD流水线，自动触发代码扫描、静态分析和构建脚本，确保每一次提交都经过自动化验证。初始化`.editorconfig`文件以统一不同编辑器下的代码格式化标准，禁止使用IDE的自动格式化，强制开发者在提交前手动调整文件结构，保证代码风格的一致性。初始化`.prettierrc`和`eslint.config.js`配置，定义代码缩进、行间距、注释风格及ESLint规则，确保所有代码片段在提交前自动通过lint检查，杜绝低