# 开发规范 ## 元数据 | 属性 | 值 | |------|-----| | **领域** | 技术 | | **责任人** | 徐聪 (costcodev) | | **版本** | v1.0 | | **创建日期** | 2026-06-22 | | **标签** | 开发规范, 代码风格, Git, 项目管理 | ## 概述定义团队统一的代码编写、项目管理、协作流程规范。目的是确保代码可维护、可交接，降低协作摩擦。 ## 正文 ### 一、代码规范 1. **Python** - 遵循 PEP 8 代码风格 - 使用 `black` 自动格式化，行宽 100 - 类型注解必须（`mypy --strict` 通过） - 文档字符串用 Google 风格 2. **TypeScript/JavaScript** - 使用 `prettier` 格式化 - ESLint 严格模式 - 禁止 `any` 类型（除非显式标注 `// eslint-disable-next-line`） - 所有公共 API 必须有 JSDoc 3. **通用规则** - 函数单一职责，不超过 50 行 - 命名：camelCase（变量/函数）、PascalCase（类/组件）、UPPER_SNAKE（常量） - 禁止 `print` / `console.log` 残留（用日志库） - 禁止注释掉的代码（相信 Git） ### 二、Git 规范 1. **分支策略** ``` main ─── 生产环境 develop ─── 开发主线 feature/- ─── 功能分支 fix/- ─── 修复分支 ``` 2. **Commit 格式** ``` ():