diff --git a/.cursor/rules/git.mdc b/.cursor/rules/git.mdc index 4f858d4de74e603be94c07a86754042933d82634..2839f7bcaffdfb1a54bc0ad8e0fad76d0dce5ff3 100644 --- a/.cursor/rules/git.mdc +++ b/.cursor/rules/git.mdc @@ -5,43 +5,50 @@ alwaysApply: true --- # Git 规则 -## 重要原则 -- 禁止自动提交 git 代码,除非有明确指令 -- 若由AI自动提交,提交信息中必须包含(AI Assistant)标识 -- 提交前必须确保所有测试通过 -- 提交信息必须简洁明了,准确描述变更内容 -- 禁止一次性提交大量无关变更,必须将变更拆分为小且相关的提交 +## 核心原则 +- 禁止AI自动提交,除非明确授权 +- AI提交必须标注(AI Assistant) +- 提交前测试必须通过 +- 提交信息必须准确描述变更 +- 禁止混合提交无关变更 -## 提交规范 -- 提交信息必须符合以下模板:(): -- 冒号 : 后必须有空格 -- type 必须为以下枚举值之一: - - feat: 新增功能 - - fix: 修复bug - - docs: 文档注释 - - style: 代码格式(不影响代码运行的变动) - - refactor: 重构、优化(既不增加新功能, 也不是修复bug) - - perf: 性能优化 - - test: 增加测试 - - chore: 构建过程或辅助工具的变动 - - revert: 回退 - - build: 打包 -- 若 subject 涉及多项变更,必须使用要点列表,每个要点以"-"开头,逐条列出 +## 提交格式 +- 格式:`[类型] 模块: 描述` +- 类型: + - [新增] - 新功能 + - [修复] - 问题修复 + - [文档] - 文档更新 + - [格式] - 代码格式 + - [重构] - 代码重构 + - [优化] - 性能优化 + - [测试] - 测试相关 + - [配置] - 配置变更 + - [回退] - 撤销提交 + - [打包] - 构建相关 +- 多项变更使用"-"列表 -## 分支管理 -- main/master 分支必须保持稳定且可发布 -- develop 分支用于集成最新开发特性 -- feature/* 分支必须用于新功能开发 -- bugfix/* 分支必须用于 bug 修复 -- release/* 分支必须用于发布准备 -- 分支命名建议按照下表执行,可根据项目需求调整 +## 分支规范 +- main/master:生产分支 +- develop:开发分支 +- feature/*:功能分支 +- bugfix/*:修复分支 +- release/*:发布分支 +- hotfix/*:热修复分支 -| 分支类型 | 命名格式 | 示例 | -| ---- | ----- | ---- | -| 功能分支 | feature/[描述] | feature/user-auth | -| 修复分支 | fix/[问题ID]-[描述] | fix/issue-42-login-crash | -| 发布分支 | release/[版本] | release/v2.1.0 | -| 热修复分支 | hotfix/[版本]-[描述] | hotfix/v2.0.1-payment-fix | +## 分支命名 +| 类型 | 格式 | 示例 | +|------|------|------| +| 功能 | feature/[描述] | feature/用户认证 | +| 修复 | fix/[问题]-[描述] | fix/issue-42-登录 | +| 发布 | release/[版本] | release/v2.1.0 | +| 热修复 | hotfix/[版本]-[描述] | hotfix/v2.0.1-支付 | +## 执行要求 +- 提交前代码测试通过 +- 重要变更需要代码审查 +- 定期清理已合并分支 +- 保持提交历史清晰 +- 发布前充分测试 +- 使用语义化版本号 diff --git a/.cursor/rules/gitflow.mdc b/.cursor/rules/gitflow.mdc deleted file mode 100644 index 1244dacef0399ae1dd8ed7341421b25f2c732d4c..0000000000000000000000000000000000000000 --- a/.cursor/rules/gitflow.mdc +++ /dev/null @@ -1,114 +0,0 @@ ---- -description: -globs: -alwaysApply: false ---- -# Gitflow工作流规则(适用于中大型项目) - -## 适用范围 -- 本规则适用于中大型项目 -- 小型项目可根据实际需求简化 -- 团队可根据实际情况调整工作流 - -## 主分支 - -### main(或master) -- main分支必须包含生产就绪代码 -- 禁止直接提交到main分支 -- main分支只接受来自以下分支的合并: - - hotfix/* 分支 - - release/* 分支 -- 每次合并后必须使用版本号标记 - -### develop -- develop是主开发分支 -- develop必须包含最新交付的开发变更 -- develop是功能分支的源分支 -- 禁止直接提交到develop分支 - -## 支持分支 - -### feature/* -- feature分支必须从develop分支创建 -- feature分支必须合并回develop分支 -- feature分支命名必须遵循:feature/[issue-id]-描述性名称 -- 示例:feature/123-user-authentication -- 创建PR前必须与develop分支保持同步 -- 合并后必须删除feature分支 - -### release/* -- release分支必须从develop分支创建 -- release分支必须合并回main和develop分支 -- release分支命名必须遵循:release/vX.Y.Z -- 示例:release/v1.2.0 -- release分支仅允许进行bug修复、文档编写及与发布相关的任务 -- release分支禁止添加新功能 -- 合并后必须删除release分支 - -### hotfix/* -- hotfix分支必须从main分支创建 -- hotfix分支必须合并回main和develop分支 -- hotfix分支命名必须遵循:hotfix/vX.Y.Z -- 示例:hotfix/v1.2.1 -- hotfix分支仅用于紧急生产环境修复 -- 合并后必须删除hotfix分支 - -## 提交信息 - -- 提交信息格式必须为:`type(scope): description` -- type类型必须为以下之一: - - feat: 新功能 - - fix: Bug修复 - - docs: 文档变更 - - style: 格式调整、缺失分号等 - - refactor: 代码重构 - - test: 添加测试 - - chore: 维护任务 - -## 版本控制 - -### 语义化版本 -- MAJOR版本用于不兼容的API变更 -- MINOR版本用于向后兼容的功能性变更 -- PATCH版本用于向后兼容的bug修复 - -## Pull Request规则 - -1. 所有变更必须通过Pull Request进行 -2. 必须获得至少1个批准 -3. CI检查必须通过 -4. 禁止直接提交到受保护分支(main/master, develop) -5. 合并前分支必须保持最新 -6. 合并后必须删除分支 - -## 分支保护规则 - -### main/master和develop -- main/master和develop分支必须要求Pull Request审核 -- main/master和develop分支必须要求状态检查通过 -- main/master和develop分支必须要求分支保持最新 -- main/master和develop分支限制规则必须包括管理员 -- main/master和develop分支禁止强制推送 -- main/master和develop分支禁止删除 - -## 发布流程 - -1. 必须从develop创建release分支 -2. 必须更新版本号 -3. 必须修复任何与发布相关的问题 -4. 必须创建PR到main -5. 合并到main后必须执行: - - 标记发布 - - 合并回develop - - 删除release分支 - -## 热修复流程 - -1. 必须从main创建hotfix分支 -2. 必须修复问题 -3. 必须更新patch版本号 -4. 必须创建PR到main -5. 合并到main后必须执行: - - 标记发布 - - 合并回develop - - 删除hotfix分支 \ No newline at end of file diff --git a/.cursor/rules/svn.mdc b/.cursor/rules/svn.mdc new file mode 100644 index 0000000000000000000000000000000000000000..3cb3514d9869f7f43b8d07dd2b871a561f2d1107 --- /dev/null +++ b/.cursor/rules/svn.mdc @@ -0,0 +1,56 @@ +--- +description: +globs: +alwaysApply: false +--- +# SVN 规则 + +## 核心原则 +- 禁止AI自动提交,除非明确授权 +- AI提交必须标注(AI Assistant) +- 提交前测试必须通过 +- 提交信息必须准确描述变更 +- 禁止混合提交无关变更 + +## 提交格式 +- 格式:`[类型] 模块: 描述` +- 类型: + - [新增] - 新功能 + - [修复] - 问题修复 + - [文档] - 文档更新 + - [格式] - 代码格式 + - [重构] - 代码重构 + - [优化] - 性能优化 + - [测试] - 测试相关 + - [配置] - 配置变更 + - [回退] - 撤销提交 + - [打包] - 构建相关 +- 多项变更使用"-"列表 + +## 目录结构 +- trunk:主干分支 +- branches/feature/*:功能分支 +- branches/bugfix/*:修复分支 +- branches/release/*:发布分支 +- branches/hotfix/*:热修复分支 +- tags/*:版本标签 + +## 分支命名 +| 类型 | 格式 | 示例 | +|------|------|------| +| 功能 | branches/feature/[描述] | branches/feature/用户认证 | +| 修复 | branches/bugfix/[问题]-[描述] | branches/bugfix/issue-42-登录 | +| 发布 | branches/release/[版本] | branches/release/v2.1.0 | +| 热修复 | branches/hotfix/[版本]-[描述] | branches/hotfix/v2.0.1-支付 | +| 标签 | tags/[版本] | tags/v1.2.0 | + +## 执行要求 +- 提交前代码测试通过 +- 重要变更需要代码审查 +- 定期清理已合并分支 +- 保持提交历史清晰 +- 发布前充分测试 +- 使用语义化版本号 + + + diff --git a/MEMORY.md b/MEMORY.md index 26c630c42e2ae588a84ab0a71c7086d5488e52c4..751bee7ae952e848da00e303751c4de3fd792089 100644 --- a/MEMORY.md +++ b/MEMORY.md @@ -40,7 +40,6 @@ Cursor Rules 是专为 Cursor IDE 设计的开发规则与文档管理体系, #### 4. AI指令系统 - [x] .cursor/rules/prompts.mdc - AI指令系统定义 -- [x] .cursor/rules/modes.mdc - 结构化模式定义 - [x] 18个核心AI指令设计完成 - [x] 结构化模式工作流设计完成 @@ -62,18 +61,17 @@ Cursor Rules 是专为 Cursor IDE 设计的开发规则与文档管理体系, - **优化内容**: 完善AI指令系统,增加优先级控制和状态管理 - **变更详情**: - 新增指令优先级规则:模式指令 > 普通指令 - - 完善模式状态管理:新增 `@ai mode exit` 退出机制 - - 增加快捷模式切换:支持单字母模式切换(r/i/p/e/v) + - 完善模式状态管理:新增 `@exit` 退出机制 - 强化指令系统检查机制:强制验证指令定义 - 完善错误处理机制:提供明确的错误提示和处理 - - 更新相关文档:README.md、prompts.mdc、modes.mdc、general.mdc + - 更新相关文档:README.md、prompts.mdc、general.mdc - **影响范围**: 整个AI指令系统、用户体验、文档结构 - **状态**: 已完成 #### 2025年06月22日 - 指令系统格式统一 -- **优化内容**: 统一AI指令格式,去除单字母指令 +- **优化内容**: 统一AI指令格式,采用全拼指令格式 - **变更详情**: - - 将单字母指令(如 `@ai h`)改为全拼格式(如 `@ai help`) + - 采用全拼指令格式(如 `@help`) - 更新README.md中的指令对照表 - 确保与prompts.mdc文档保持一致 - **影响范围**: README.md、用户使用习惯 @@ -82,15 +80,15 @@ Cursor Rules 是专为 Cursor IDE 设计的开发规则与文档管理体系, ### 📋 待开发功能 #### 1. 框架规范扩展 -- [ ] .cursor/rules/framework/angular.mdc -- [ ] .cursor/rules/framework/vuejs.mdc -- [ ] .cursor/rules/framework/flutter.mdc -- [ ] .cursor/rules/framework/nextjs.mdc -- [ ] .cursor/rules/framework/springboot.mdc -- [ ] .cursor/rules/framework/tailwind.mdc +- [x] .cursor/rules/framework/angular.mdc +- [x] .cursor/rules/framework/vuejs.mdc +- [x] .cursor/rules/framework/flutter.mdc +- [x] .cursor/rules/framework/nextjs.mdc +- [x] .cursor/rules/framework/springboot.mdc +- [x] .cursor/rules/framework/tailwind.mdc #### 2. 语言规范扩展 -- [ ] .cursor/rules/language/typescript.mdc +- [x] .cursor/rules/language/typescript.mdc - [ ] 其他主流语言规范 #### 3. AI会话管理 @@ -98,9 +96,9 @@ Cursor Rules 是专为 Cursor IDE 设计的开发规则与文档管理体系, - [ ] 会话状态记录机制 #### 4. 历史记录系统 -- [ ] docs/ai/history/code-reviews/ 代码审查历史 -- [ ] docs/ai/history/summaries/ 项目总结历史 -- [ ] docs/ai/history/troubleshooting/ 问题诊断历史 +- [x] docs/ai/history/code-reviews/ 代码审查历史目录 +- [x] docs/ai/history/summaries/ 项目总结历史目录 +- [x] docs/ai/history/troubleshooting/ 问题诊断历史目录 ## 重要决策记录 @@ -139,8 +137,7 @@ Cursor Rules 是专为 Cursor IDE 设计的开发规则与文档管理体系, **具体优化**: - 新增指令优先级规则:模式指令 > 普通指令 -- 完善模式状态管理:新增 `@ai mode exit` 退出机制 -- 增加快捷模式切换:支持单字母模式切换(r/i/p/e/v) +- 完善模式状态管理:新增 `@exit` 退出机制 - 强化指令系统检查机制:强制验证指令定义 - 完善错误处理机制:提供明确的错误提示和处理 @@ -152,7 +149,7 @@ Cursor Rules 是专为 Cursor IDE 设计的开发规则与文档管理体系, ### 3. 指令系统格式统一决策 **时间**: 2025年06月22日 -**决策**: 采用全拼指令格式,去除单字母指令 +**决策**: 采用全拼指令格式,提高语义清晰度 **原因**: - 提高指令语义清晰度 - 避免单字母指令的歧义 @@ -190,7 +187,7 @@ Cursor Rules 是专为 Cursor IDE 设计的开发规则与文档管理体系, - **解决方案**: 创建迁移指南,提供新旧指令对照表 ### 4. 规则文件扩展 -- **问题**: 框架和语言规范文件尚未创建 +- **问题**: 其他语言规范文件尚未创建 - **优先级**: 低 - **解决方案**: 按需逐步添加 @@ -199,35 +196,55 @@ Cursor Rules 是专为 Cursor IDE 设计的开发规则与文档管理体系, ### 短期目标(1-2周) 1. 全面测试重构后的指令系统 2. 创建用户迁移指南 -3. 验证新指令格式在各种场景下的稳定性 -4. 完善AI会话管理机制 +3. 完善历史记录系统示例 ### 中期目标(1个月) -1. 添加主流框架规范 -2. 完善语言规范体系 -3. 优化文档结构和用户体验 -4. 收集用户反馈并持续改进 +1. 扩展语言规范文件 +2. 完善AI会话管理功能 +3. 建立自动化测试机制 ### 长期目标(3个月) -1. 项目稳定版本发布 -2. 用户反馈收集和优化 -3. 社区推广和文档完善 -4. 考虑扩展更多AI协作功能 - -## 项目状态 - -**当前阶段**: 开发阶段 -**稳定性**: 基础功能稳定,指令系统已重构优化,可投入使用 -**测试状态**: 基础功能已测试,新指令系统待全面测试 -**文档状态**: 核心文档完整且已更新,待扩展 -**指令系统**: 已重构优化,使用 `@[指令名]` 格式,具备三级优先级系统 - -## 注意事项 - -1. **模板状态**: 所有文档应保持模板格式,使用占位符 `[内容]` -2. **通用性**: 避免记录特定项目信息,保持模板的通用性 -3. **文档同步**: 定期检查各文档间的一致性 -4. **规则遵循**: AI应始终遵循 `.cursor/rules/` 目录中的规范 +1. 社区反馈收集和优化 +2. 性能优化和扩展性提升 +3. 更多框架和语言支持 + +## 环境信息 + +### 开发环境 +- 操作系统:Windows 10 +- 开发工具:Cursor IDE +- 版本控制:Git + +### 项目配置 +- 规则文件位置:.cursor/rules/ +- 文档目录:docs/ +- AI记忆文件:docs/ai/memory.md + +### 重要配置 +- 指令系统:18个核心指令,三级优先级 +- 模式系统:5个核心模式,状态管理完善 +- 文档结构:极简设计,2个核心文档 + +## 使用说明 + +### 更新频率 +- 重要决策后立即更新 +- 每周定期回顾和更新 +- 项目里程碑后全面更新 + +### 更新内容 +- 技术决策和架构变更 +- 重要配置信息变更 +- 环境信息更新 +- 问题解决记录 + +### 维护原则 +- 保持信息的准确性和时效性 +- 重点记录影响开发的关键信息 +- 避免记录过于详细的技术细节 +- 定期清理过时信息 + +*本文档用于记录项目的关键信息和上下文,帮助AI助手更好地理解项目状态和做出决策* --- diff --git a/README.md b/README.md index 9c5cc451361fc890c032f36309d509b067a71557..60fed254128c3296e318ade873ae8c35a2ea1e0d 100644 --- a/README.md +++ b/README.md @@ -1,143 +1,67 @@ -# Cursor Rules 项目 +# Cursor Rules -**Cursor Rules** 是专为 Cursor IDE 设计的开发规则与文档管理体系,致力于为开发团队提供一套标准化、智能化、极简高效的协作与知识管理方案。 +**Cursor Rules** 是专为 Cursor IDE 设计的开发规则与文档管理体系,提供标准化、智能化、极简高效的协作与知识管理方案。 -## 项目定位 +## 核心价值 -- **标准化开发**:统一团队开发规范,覆盖多语言、多框架,提升协作效率。 -- **智能文档管理**:极简文档结构,便于维护和查找,支持 AI 辅助知识积累。 -- **AI 协作驱动**:集成 AI 辅助开发、决策记录、经验沉淀与自动化指令体系。 -- **全周期覆盖**:涵盖需求、设计、开发、测试、部署、归档等完整开发生命周期。 +- **标准化开发**:统一团队开发规范,覆盖多语言、多框架 +- **智能文档管理**:极简文档结构,AI 辅助知识积累 +- **AI 协作驱动**:集成 AI 辅助开发、决策记录、经验沉淀 +- **全周期覆盖**:涵盖需求、设计、开发、测试、部署、归档 -## 主要特性 +## 核心特性 -- **极简目录结构**:仅需 2 个核心文档(产品文档、开发文档),AI 记忆与归档独立管理。 -- **规则驱动**:所有规范集中于 `.cursor/rules/` 目录,AI 可自动遵循。 -- **多技术栈支持**:内置主流前后端、移动端、样式框架及语言规范。 -- **AI 快捷指令**:一行指令即可调用常用协作、文档、总结等自动化操作。 -- **工作流程指导**:提供结构化开发流程,帮助保持思维专注。 -- **团队友好**:文档模板、命名、版本管理、归档机制一应俱全,便于新成员快速上手。 - -## 重要说明 - -### 通用模板设计原则 -- **保持模板状态**:本项目作为通用模板,所有文档应保持模板格式,使用占位符 `[内容]` -- **无需具体记忆**:`docs/ai/memory.md` 应保持模板状态,不填充具体项目信息 -- **避免冗余内容**:不记录特定项目的决策、状态或任务,确保模板的通用性 -- **即用即填**:迁移到具体项目时,再根据实际情况填充模板内容 - -### 文档维护策略 -- **产品文档**:保持模板格式,包含需求分析、系统设计等标准结构 -- **开发文档**:保持模板格式,包含开发进度、测试管理、部署运维等标准结构 -- **AI记忆**:保持模板格式,提供项目上下文记录的标准框架 -- **AI指令**:保持通用性,适用于各种软件开发项目 - -## 目录结构(示例) - -``` -cursor-rules/ -├── docs/ # 文档目录 -│ ├── 01-产品文档.md # 产品需求和设计 -│ ├── 02-开发文档.md # 开发规范和流程 -│ ├── docs-structure.mdc # 文档结构规范 -│ └── ai/ # AI 相关文档 -│ ├── memory.md # 项目记忆 -│ └── history/ # 历史记录目录 -│ ├── code-reviews/ # 代码审查历史 -│ ├── summaries/ # 项目总结历史 -│ └── troubleshooting/ # 问题诊断历史 -├── .cursor/ # 规则与配置目录 -│ └── rules/ # 规则定义目录 -│ ├── general.mdc # 通用规范 -│ ├── prompts.mdc # AI指令系统 -│ ├── git.mdc # Git提交规范 -│ ├── gitflow.mdc # Gitflow工作流规范 -│ ├── framework/ # 各类主流框架规范 -│ │ ├── angular.mdc -│ │ ├── vuejs.mdc -│ │ ├── flutter.mdc -│ │ ├── nextjs.mdc -│ │ ├── springboot.mdc -│ │ └── tailwind.mdc -│ └── language/ # 语言规范 -│ └── typescript.mdc -├── LICENSE # 开源协议 -└── README.md # 项目说明(本文件) -``` +- **规则驱动**:所有规范集中于 `.cursor/rules/` 目录,AI 可自动遵循 +- **AI 指令系统**:18个核心指令,支持结构化工作流程 +- **极简结构**:仅需 2 个核心文档,AI 记忆与归档独立管理 +- **多技术栈**:内置主流框架及语言规范 +- **团队友好**:文档模板、版本管理、归档机制一应俱全 ## 快速上手 -1. **查阅规范**:所有文档结构与协作规范详见 `.cursor/rules/` 目录和 `docs/` 目录。 -2. **文档维护**:仅需维护 2 个核心文档,AI 记忆与归档自动管理。 -3. **AI 协作**:通过 `@[指令名]` 快捷指令,快速调用常用操作。 -4. **工作流程**:使用结构化模式指导开发流程,保持思维专注。 -5. **团队协作**:新成员可通过项目根目录 README.md 快速了解项目结构与协作方式。 - ---- +1. **查阅规则**:详见 `.cursor/rules/` 目录 +2. **使用指令**:通过 `@[指令名]` 快捷指令快速操作 +3. **文档维护**:仅需维护 2 个核心文档 +4. **工作流程**:使用结构化模式指导开发流程 -## AI 快捷指令系统 +## AI 指令系统 ### 核心指令(18个) -| 指令 | 功能 | 使用场景 | 优先级 | -|------|------|----------|--------| -| `@research` | 研究模式 | 信息收集和深度理解 | 最高 | -| `@plan` | 规划模式 | 制定详细计划 | 最高 | -| `@execute` | 执行模式 | 精确实施规划内容 | 最高 | -| `@review` | 审查模式 | 验证实施与计划的一致性 | 最高 | -| `@innovate` | 创新模式 | 头脑风暴潜在方法 | 最高 | -| `@status` | 查看状态 | 显示当前模式状态 | 中等 | -| `@exit` | 退出模式 | 退出当前模式 | 中等 | -| `@reset` | 重置模式 | 重置模式状态 | 中等 | -| `@help` | 帮助查询 | 忘记指令时快速查看 | 普通 | -| `@memory` | 更新开发记忆 | 重要决策后记录 | 普通 | -| `@document` | 更新项目文档 | 功能完成后同步 | 普通 | -| `@code` | 代码审查 | 代码提交前检查 | 普通 | -| `@troubleshoot` | 问题诊断 | 遇到问题时分析 | 普通 | -| `@summary` | 项目总结 | 阶段完成时总结 | 普通 | -| `@unified` | 综合验证检查 | 项目变更后检查 | 普通 | -| `@git` | Git提交 | 代码提交前生成信息 | 普通 | -| `@rules` | 规则检查 | 确保AI遵循项目规范 | 普通 | - -### 指令优先级规则 -- **最高优先级**:模式指令(`@research`, `@plan`, `@execute` 等) -- **中等优先级**:状态指令(`@status`, `@exit`, `@reset`) -- **普通优先级**:功能指令(`@help`, `@git`, `@memory` 等) -- **模式激活时**:只执行模式相关指令,其他指令提示退出 +| 指令 | 功能 | 优先级 | +|------|------|--------| +| `@research` | 研究模式 | 最高 | +| `@plan` | 规划模式 | 最高 | +| `@execute` | 执行模式 | 最高 | +| `@review` | 审查模式 | 最高 | +| `@innovate` | 创新模式 | 最高 | +| `@status` | 查看状态 | 中等 | +| `@exit` | 退出模式 | 中等 | +| `@reset` | 重置模式 | 中等 | +| `@help` | 帮助查询 | 普通 | +| `@memory` | 更新开发记忆 | 普通 | +| `@document` | 更新项目文档 | 普通 | +| `@code` | 代码审查 | 普通 | +| `@troubleshoot` | 问题诊断 | 普通 | +| `@summary` | 项目总结 | 普通 | +| `@unified` | 综合验证检查 | 普通 | +| `@git` | Git提交 | 普通 | +| `@rules` | 规则检查 | 普通 | ### 结构化模式 -提供工作流程指导,帮助在特定阶段保持思维专注。 +提供工作流程指导,帮助保持思维专注: -#### 工作流程 -- **研究模式**:信息收集和深度理解 -- **创新模式**:头脑风暴潜在方法 -- **规划模式**:创建详尽的技术规范 -- **执行模式**:精确实施规划内容 -- **审查模式**:验证实施与计划的一致性 - -#### 模式切换 ```bash -# 模式切换 @research # 研究模式 - 信息收集和深度理解 @innovate # 创新模式 - 头脑风暴潜在方法 @plan # 规划模式 - 制定详细计划 @execute # 执行模式 - 精确实施规划内容 @review # 审查模式 - 验证实施与计划的一致性 - -# 状态管理 -@status # 查看状态 -@exit # 退出当前模式 -@reset # 重置模式状态 ``` -#### 模式状态管理 -- **模式激活时**:只响应模式相关指令 -- **其他指令**:需要先使用 `@exit` 退出模式 -- **模式退出后**:恢复正常指令执行 -- **会话开始**:默认处于普通模式 +### 使用流程 -#### 使用流程示例 ```bash # 典型开发任务流程 @research # 1. 分析任务需求和技术约束 @@ -147,35 +71,38 @@ cursor-rules/ @review # 5. 验证实施结果 ``` -#### 使用特点 -- **指导性工具**:模式为指导性,非强制约束 -- **灵活切换**:可根据需要自由切换模式 -- **工作流程**:提供研究→创新→规划→执行→审查的指导 -- **会话独立**:每个会话独立,无状态依赖 -- **状态控制**:模式激活时有明确的状态管理机制 - -### 指令优势 -- **指令简洁**:使用 `@[指令名]` 格式,更直观易用 -- **优先级清晰**:三级优先级系统,逻辑更明确 -- **模式专注**:5个核心模式,工作流程更清晰 -- **状态管理**:完善的模式状态切换和退出机制 -- **错误处理**:明确的错误提示和处理机制 -- **高频使用**:覆盖日常开发90%的AI协作需求 -- **即插即用**:适用于任何软件开发项目 -- **规范确保**:`@rules` 指令确保AI始终遵循项目规范 -- **专注工作流**:结构化模式提供专注开发流程,适合复杂任务处理 -- **工作流程指导**:帮助保持思维专注,提升工作质量 +## 项目结构 ---- +``` +cursor-rules/ +├── .cursor/rules/ # 规则定义目录(核心) +│ ├── general.mdc # 通用规范 +│ ├── prompts.mdc # AI指令系统 +│ ├── git.mdc # Git提交规范 +│ ├── framework/ # 框架规范 +│ └── language/ # 语言规范 +├── docs/ # 文档目录 +│ ├── 01-产品文档.md # 产品需求和设计 +│ ├── 02-开发文档.md # 开发规范和流程 +│ └── ai/ # AI 相关文档 +├── LICENSE # 开源协议 +└── README.md # 项目说明 +``` + +## 重要说明 + +### 通用模板设计原则 +- **保持模板状态**:所有文档应保持模板格式,使用占位符 `[内容]` +- **即用即填**:迁移到具体项目时,再根据实际情况填充模板内容 +- **避免冗余**:不记录特定项目的决策、状态或任务,确保模板的通用性 ## 💡 最佳实践 -### 指令系统使用建议 +1. **规则优先**:优先使用 `.cursor/rules/` 中的规则 +2. **指令驱动**:通过 AI 指令系统提高开发效率 +3. **模式使用**:复杂任务时使用结构化模式,保持思维专注 +4. **文档同步**:重要变更后使用 `@document` 同步文档 -1. **模式使用**:复杂任务时使用结构化模式,保持思维专注 -2. **指令记忆**:记住核心指令,使用 `@help` 快速查询 -3. **文档同步**:重要变更后使用 `@document` 同步文档 -4. **规则检查**:定期使用 `@rules` 确保AI遵循项目规范 -5. **记忆更新**:重要决策后使用 `@memory` 记录 +--- -如需详细规则、模板、最佳实践,请查阅 `.cursor/rules/` 目录。 +**详细规则、模板、最佳实践,请查阅 `.cursor/rules/` 目录。** diff --git a/docs/ai/history/code-reviews/README.md b/docs/ai/history/code-reviews/README.md new file mode 100644 index 0000000000000000000000000000000000000000..c622a77863275ce57d57749baa1801c621d535bf --- /dev/null +++ b/docs/ai/history/code-reviews/README.md @@ -0,0 +1,83 @@ +# 代码审查历史 + +## 目录说明 + +本目录用于存储项目的代码审查历史记录,按时间顺序组织,便于追踪代码质量改进和最佳实践积累。 + +## 文件命名规范 + +``` +YYYY-MM-DD-[模块名]-[审查类型].md +``` + +### 示例 +- `2025-06-22-指令系统-重构审查.md` +- `2025-06-22-文档结构-格式审查.md` +- `2025-06-22-规则文件-完整性审查.md` + +## 审查记录模板 + +```markdown +# 代码审查记录 + +## 基本信息 +- **审查日期**: YYYY-MM-DD +- **审查模块**: [模块名称] +- **审查类型**: [重构/新增/修复/优化] +- **审查人员**: [审查者] +- **代码作者**: [开发者] + +## 审查范围 +- [文件1]: [变更描述] +- [文件2]: [变更描述] +- [文件3]: [变更描述] + +## 审查结果 + +### ✅ 优点 +- [优点1] +- [优点2] +- [优点3] + +### ⚠️ 问题 +- [问题1]: [严重程度] - [建议] +- [问题2]: [严重程度] - [建议] + +### 🔧 改进建议 +- [建议1] +- [建议2] +- [建议3] + +## 质量评估 +- **代码质量**: [优秀/良好/一般/需改进] +- **可维护性**: [优秀/良好/一般/需改进] +- **性能影响**: [无影响/轻微/中等/显著] +- **安全风险**: [无风险/低风险/中等风险/高风险] + +## 后续行动 +- [ ] [行动项1] +- [ ] [行动项2] +- [ ] [行动项3] + +## 经验总结 +[记录本次审查的经验和最佳实践] + +--- +*本文档模板用于标准化代码审查记录格式* +``` + +## 使用说明 + +1. **创建记录**: 每次代码审查后创建对应的记录文件 +2. **及时更新**: 审查完成后立即记录,确保信息准确 +3. **定期回顾**: 定期回顾历史记录,总结经验教训 +4. **持续改进**: 根据历史记录持续改进代码审查流程 + +## 最佳实践 + +1. **客观记录**: 保持客观公正,重点记录问题和改进建议 +2. **详细描述**: 详细描述问题和建议,便于后续参考 +3. **分类整理**: 按模块和类型分类整理,便于查找 +4. **经验积累**: 记录审查经验,形成最佳实践 + +*本目录为代码审查历史记录提供标准化模板和指导* \ No newline at end of file diff --git a/docs/ai/history/summaries/README.md b/docs/ai/history/summaries/README.md new file mode 100644 index 0000000000000000000000000000000000000000..aca78b2da63100f72371d93a42804e93094de1c8 --- /dev/null +++ b/docs/ai/history/summaries/README.md @@ -0,0 +1,140 @@ +# 项目总结历史 + +## 目录说明 + +本目录用于存储项目的阶段性总结和历史记录,按时间顺序组织,便于追踪项目进展和决策历程。 + +## 文件命名规范 + +``` +YYYY-MM-DD-[阶段名]-[总结类型].md +``` + +### 示例 +- `2025-06-22-指令系统-重构总结.md` +- `2025-06-22-文档体系-完善总结.md` +- `2025-06-22-项目初期-架构总结.md` + +## 总结记录模板 + +```markdown +# 项目总结记录 + +## 基本信息 +- **总结日期**: YYYY-MM-DD +- **项目阶段**: [阶段名称] +- **总结类型**: [重构/新增/完善/优化/里程碑] +- **总结人员**: [总结者] +- **项目状态**: [进行中/已完成/暂停/终止] + +## 阶段概述 +[简要描述本阶段的主要工作和目标] + +## 完成情况 + +### ✅ 已完成工作 +- [工作1]: [完成度] - [影响] +- [工作2]: [完成度] - [影响] +- [工作3]: [完成度] - [影响] + +### 🔄 进行中工作 +- [工作1]: [进度] - [预计完成时间] +- [工作2]: [进度] - [预计完成时间] + +### 📋 待开始工作 +- [工作1]: [优先级] - [计划开始时间] +- [工作2]: [优先级] - [计划开始时间] + +## 重要决策 + +### 技术决策 +- [决策1]: [背景] - [选择] - [影响] +- [决策2]: [背景] - [选择] - [影响] + +### 架构决策 +- [决策1]: [问题] - [解决方案] - [影响] +- [决策2]: [问题] - [解决方案] - [影响] + +### 业务决策 +- [决策1]: [背景] - [决定] - [理由] +- [决策2]: [背景] - [决定] - [理由] + +## 技术债务 + +### 代码债务 +- [债务1]: [问题描述] - [影响] - [计划解决时间] +- [债务2]: [问题描述] - [影响] - [计划解决时间] + +### 架构债务 +- [债务1]: [问题描述] - [影响] - [计划解决时间] +- [债务2]: [问题描述] - [影响] - [计划解决时间] + +### 文档债务 +- [债务1]: [问题描述] - [影响] - [计划解决时间] +- [债务2]: [问题描述] - [影响] - [计划解决时间] + +## 经验教训 + +### 成功经验 +- [经验1]: [具体做法] - [效果] +- [经验2]: [具体做法] - [效果] + +### 失败教训 +- [教训1]: [问题描述] - [原因分析] - [改进措施] +- [教训2]: [问题描述] - [原因分析] - [改进措施] + +## 下一步计划 + +### 短期目标(1-2周) +- [目标1]: [具体内容] - [负责人] +- [目标2]: [具体内容] - [负责人] + +### 中期目标(1个月) +- [目标1]: [具体内容] - [负责人] +- [目标2]: [具体内容] - [负责人] + +### 长期目标(3个月) +- [目标1]: [具体内容] - [负责人] +- [目标2]: [具体内容] - [负责人] + +## 风险评估 + +### 技术风险 +- [风险1]: [影响] - [概率] - [缓解措施] +- [风险2]: [影响] - [概率] - [缓解措施] + +### 业务风险 +- [风险1]: [影响] - [概率] - [缓解措施] +- [风险2]: [影响] - [概率] - [缓解措施] + +## 质量评估 +- **代码质量**: [优秀/良好/一般/需改进] +- **文档质量**: [优秀/良好/一般/需改进] +- **测试覆盖**: [优秀/良好/一般/需改进] +- **用户体验**: [优秀/良好/一般/需改进] + +## 团队表现 +- **协作效率**: [优秀/良好/一般/需改进] +- **沟通质量**: [优秀/良好/一般/需改进] +- **问题解决**: [优秀/良好/一般/需改进] +- **知识分享**: [优秀/良好/一般/需改进] + +--- +*本文档模板用于标准化项目总结记录格式* +``` + +## 使用说明 + +1. **定期总结**: 每个重要阶段结束后进行总结 +2. **及时记录**: 重要决策和变更后立即记录 +3. **客观评估**: 保持客观公正,记录真实情况 +4. **持续改进**: 根据总结持续改进工作流程 + +## 最佳实践 + +1. **全面覆盖**: 涵盖技术、业务、团队等各个方面 +2. **数据支撑**: 使用具体数据和指标支撑总结 +3. **经验积累**: 重点记录经验和教训,便于后续参考 +4. **行动计划**: 制定明确的后续行动计划 + +*本目录为项目总结历史记录提供标准化模板和指导* \ No newline at end of file diff --git a/docs/ai/history/troubleshooting/README.md b/docs/ai/history/troubleshooting/README.md new file mode 100644 index 0000000000000000000000000000000000000000..3c23ec46bc9114b1652be625fe722cd795401477 --- /dev/null +++ b/docs/ai/history/troubleshooting/README.md @@ -0,0 +1,171 @@ +# 问题诊断历史 + +## 目录说明 + +本目录用于存储项目开发过程中遇到的问题诊断和解决方案记录,按时间顺序组织,便于快速查找和参考。 + +## 文件命名规范 + +``` +YYYY-MM-DD-[问题类型]-[问题描述].md +``` + +### 示例 +- `2025-06-22-指令系统-格式冲突问题.md` +- `2025-06-22-文档结构-同步性问题.md` +- `2025-06-22-规则文件-完整性检查问题.md` + +## 问题诊断记录模板 + +```markdown +# 问题诊断记录 + +## 基本信息 +- **问题日期**: YYYY-MM-DD +- **问题类型**: [系统/配置/文档/代码/性能/安全] +- **问题严重程度**: [严重/中等/轻微] +- **影响范围**: [全局/模块/功能/用户] +- **报告人员**: [报告者] +- **解决人员**: [解决者] + +## 问题描述 + +### 现象 +[详细描述问题的具体表现和现象] + +### 环境信息 +- **操作系统**: [OS版本] +- **开发工具**: [工具版本] +- **相关配置**: [配置信息] +- **复现步骤**: [问题复现的具体步骤] + +### 错误信息 +``` +[具体的错误信息或日志] +``` + +## 问题分析 + +### 根本原因 +[分析问题的根本原因] + +### 影响因素 +- [因素1]: [影响程度] +- [因素2]: [影响程度] +- [因素3]: [影响程度] + +### 相关代码/配置 +- [文件1]: [相关代码片段或配置] +- [文件2]: [相关代码片段或配置] + +## 解决方案 + +### 解决步骤 +1. [步骤1]: [具体操作] +2. [步骤2]: [具体操作] +3. [步骤3]: [具体操作] + +### 修改内容 +- [文件1]: [修改内容] - [修改原因] +- [文件2]: [修改内容] - [修改原因] + +### 验证方法 +- [验证方法1]: [验证步骤] - [预期结果] +- [验证方法2]: [验证步骤] - [预期结果] + +## 解决方案评估 + +### 解决效果 +- **问题解决**: [是/否] +- **性能影响**: [无影响/轻微/中等/显著] +- **稳定性**: [稳定/一般/不稳定] +- **维护性**: [易维护/一般/难维护] + +### 副作用 +- [副作用1]: [影响] - [缓解措施] +- [副作用2]: [影响] - [缓解措施] + +## 经验总结 + +### 预防措施 +- [措施1]: [具体做法] - [预期效果] +- [措施2]: [具体做法] - [预期效果] + +### 最佳实践 +- [实践1]: [具体做法] - [适用场景] +- [实践2]: [具体做法] - [适用场景] + +### 注意事项 +- [注意1]: [重要提醒] +- [注意2]: [重要提醒] + +## 相关资源 + +### 参考文档 +- [文档1]: [链接] - [相关内容] +- [文档2]: [链接] - [相关内容] + +### 相关工具 +- [工具1]: [用途] - [使用说明] +- [工具2]: [用途] - [使用说明] + +### 社区资源 +- [资源1]: [链接] - [内容描述] +- [资源2]: [链接] - [内容描述] + +## 后续行动 +- [ ] [行动项1]: [负责人] - [完成时间] +- [ ] [行动项2]: [负责人] - [完成时间] +- [ ] [行动项3]: [负责人] - [完成时间] + +--- +*本文档模板用于标准化问题诊断记录格式* +``` + +## 使用说明 + +1. **及时记录**: 发现问题后立即记录,确保信息准确 +2. **详细描述**: 详细描述问题现象、分析过程和解决方案 +3. **定期回顾**: 定期回顾历史记录,总结经验教训 +4. **持续改进**: 根据历史记录持续改进问题处理流程 + +## 最佳实践 + +1. **客观记录**: 保持客观公正,重点记录分析过程和解决方案 +2. **详细分析**: 深入分析问题根本原因,避免表面解决 +3. **经验积累**: 记录预防措施和最佳实践,便于后续参考 +4. **知识分享**: 及时分享解决方案,帮助团队成员避免类似问题 + +## 问题分类 + +### 系统问题 +- 环境配置问题 +- 依赖冲突问题 +- 版本兼容问题 + +### 配置问题 +- 配置文件错误 +- 环境变量问题 +- 权限配置问题 + +### 文档问题 +- 文档同步问题 +- 格式规范问题 +- 内容一致性问题 + +### 代码问题 +- 语法错误 +- 逻辑错误 +- 性能问题 + +### 性能问题 +- 响应速度慢 +- 内存泄漏 +- 资源占用高 + +### 安全问题 +- 安全漏洞 +- 权限问题 +- 数据泄露 + +*本目录为问题诊断历史记录提供标准化模板和指导* \ No newline at end of file diff --git a/docs/git-help.md b/docs/git-help.md new file mode 100644 index 0000000000000000000000000000000000000000..adc16548b7ac5bf98418b78c0d821abd901f2a8d --- /dev/null +++ b/docs/git-help.md @@ -0,0 +1,184 @@ +--- +description: +globs: +alwaysApply: false +--- +# Git 使用帮助文档 + +## 提交信息示例 + +### 功能开发示例 +```bash +git commit -m "[新增] 用户管理: 新增用户注册功能 +- 实现用户注册接口 +- 添加邮箱验证功能 +- 完善用户信息校验" +``` + +### 问题修复示例 +```bash +git commit -m "[修复] 登录模块: 修复密码验证失败问题 +- 修正密码加密算法 +- 更新登录验证逻辑 +- 添加错误日志记录" +``` + +### 文档更新示例 +```bash +git commit -m "[文档] API文档: 更新用户管理接口文档 +- 补充接口参数说明 +- 添加错误码说明 +- 更新示例代码" +``` + +## 分支操作示例 + +### 创建分支示例 +```bash +# 创建功能分支 +git checkout -b feature/用户管理模块 + +# 创建修复分支 +git checkout -b fix/issue-123-登录问题 + +# 创建发布分支 +git checkout -b release/v1.2.0 + +# 创建热修复分支 +git checkout -b hotfix/v1.1.1-安全漏洞修复 +``` + +## 工作流程 + +### 1. 功能开发流程 +```bash +# 1. 更新开发分支 +git checkout develop +git pull origin develop + +# 2. 创建功能分支 +git checkout -b feature/新功能名称 + +# 3. 开发并提交 +git add . +git commit -m "[新增] 模块名: 功能描述" + +# 4. 推送到远程 +git push origin feature/新功能名称 + +# 5. 创建Pull Request +# 6. 代码审查通过后合并到develop +``` + +### 2. 问题修复流程 +```bash +# 1. 从develop创建修复分支 +git checkout develop +git pull origin develop +git checkout -b fix/issue-123-问题描述 + +# 2. 修复并提交 +git add . +git commit -m "[修复] 模块名: 修复问题描述" + +# 3. 推送到远程 +git push origin fix/issue-123-问题描述 + +# 4. 创建Pull Request并合并 +``` + +### 3. 版本发布流程 +```bash +# 1. 从develop创建发布分支 +git checkout develop +git checkout -b release/v1.2.0 + +# 2. 版本号更新和测试 +# 3. 合并到main和develop +git checkout main +git merge release/v1.2.0 +git tag v1.2.0 + +git checkout develop +git merge release/v1.2.0 + +# 4. 删除发布分支 +git branch -d release/v1.2.0 +``` + +### 4. 紧急修复流程 +```bash +# 1. 从main创建热修复分支 +git checkout main +git checkout -b hotfix/v1.1.1-紧急修复 + +# 2. 快速修复并提交 +git add . +git commit -m "[修复] 模块名: 紧急修复描述" + +# 3. 合并到main和develop +git checkout main +git merge hotfix/v1.1.1-紧急修复 +git tag v1.1.1 + +git checkout develop +git merge hotfix/v1.1.1-紧急修复 + +# 4. 删除热修复分支 +git branch -d hotfix/v1.1.1-紧急修复 +``` + +## 常用Git命令速查 + +### 基础操作 +```bash +git status # 查看工作区状态 +git add . # 暂存所有变更 +git commit -m "提交信息" # 提交变更 +git push origin 分支名 # 推送到远程 +git pull origin 分支名 # 从远程拉取 +``` + +### 分支操作 +```bash +git branch # 查看本地分支 +git branch -a # 查看所有分支 +git checkout 分支名 # 切换分支 +git checkout -b 新分支名 # 创建并切换分支 +git branch -d 分支名 # 删除分支 +``` + +### 查看信息 +```bash +git log --oneline -10 # 查看最近10次提交 +git log --graph --oneline --all # 查看分支图 +git show 提交ID # 查看提交详情 +git diff # 查看工作区变更 +git diff --cached # 查看暂存区变更 +``` + +### 暂存和恢复 +```bash +git stash # 暂存当前工作 +git stash list # 查看暂存列表 +git stash pop # 恢复最近的暂存 +git stash apply stash@{0} # 恢复指定暂存 +git stash drop stash@{0} # 删除指定暂存 +``` + +### 撤销操作 +```bash +git reset --soft HEAD~1 # 撤销提交但保留变更 +git reset --hard HEAD~1 # 撤销提交并丢弃变更 +git revert 提交ID # 创建撤销提交 +git checkout -- 文件名 # 撤销文件变更 +``` + +## 注意事项 +- 提交前确保代码通过测试 +- 重要变更需要代码审查 +- 定期清理已合并分支 +- 保持提交历史清晰可追溯 +- 发布前进行充分测试 +- 使用语义化版本号管理版本 + diff --git a/docs/svn-help.md b/docs/svn-help.md new file mode 100644 index 0000000000000000000000000000000000000000..63f45b064094871fdc0f77be365ff803ad3f3151 --- /dev/null +++ b/docs/svn-help.md @@ -0,0 +1,202 @@ +# SVN 使用帮助文档 + +## 提交信息示例 + +### 功能开发示例 +```bash +svn commit -m "[新增] 用户管理: 新增用户注册功能 +- 实现用户注册接口 +- 添加邮箱验证功能 +- 完善用户信息校验" +``` + +### 问题修复示例 +```bash +svn commit -m "[修复] 登录模块: 修复密码验证失败问题 +- 修正密码加密算法 +- 更新登录验证逻辑 +- 添加错误日志记录" +``` + +### 文档更新示例 +```bash +svn commit -m "[文档] API文档: 更新用户管理接口文档 +- 补充接口参数说明 +- 添加错误码说明 +- 更新示例代码" +``` + +## 分支操作示例 + +### 创建分支示例 +```bash +# 创建功能分支 +svn copy trunk branches/feature/用户管理模块 -m "[新增] 创建用户管理功能分支" + +# 创建修复分支 +svn copy trunk branches/bugfix/issue-123-登录问题 -m "[修复] 创建登录问题修复分支" + +# 创建发布分支 +svn copy trunk branches/release/v1.2.0 -m "[打包] 创建v1.2.0发布分支" + +# 创建热修复分支 +svn copy tags/v1.1.0 branches/hotfix/v1.1.1-安全漏洞修复 -m "[修复] 创建安全漏洞热修复分支" +``` + +### 合并分支示例 +```bash +# 合并功能分支到trunk +svn merge branches/feature/用户管理模块 trunk + +# 合并修复分支到trunk +svn merge branches/bugfix/issue-123-登录问题 trunk + +# 合并发布分支到trunk +svn merge branches/release/v1.2.0 trunk +``` + +## 工作流程 + +### 1. 功能开发流程 +```bash +# 1. 更新trunk +svn update trunk + +# 2. 创建功能分支 +svn copy trunk branches/feature/新功能名称 -m "[新增] 创建新功能分支" + +# 3. 切换到功能分支 +svn checkout branches/feature/新功能名称 + +# 4. 开发并提交 +svn add . +svn commit -m "[新增] 模块名: 功能描述" + +# 5. 合并回trunk +svn merge branches/feature/新功能名称 trunk +svn commit -m "[新增] 合并新功能到trunk" + +# 6. 删除功能分支 +svn delete branches/feature/新功能名称 -m "[清理] 删除已合并的功能分支" +``` + +### 2. 问题修复流程 +```bash +# 1. 从trunk创建修复分支 +svn copy trunk branches/bugfix/issue-123-问题描述 -m "[修复] 创建问题修复分支" + +# 2. 切换到修复分支 +svn checkout branches/bugfix/issue-123-问题描述 + +# 3. 修复并提交 +svn add . +svn commit -m "[修复] 模块名: 修复问题描述" + +# 4. 合并回trunk +svn merge branches/bugfix/issue-123-问题描述 trunk +svn commit -m "[修复] 合并问题修复到trunk" + +# 5. 删除修复分支 +svn delete branches/bugfix/issue-123-问题描述 -m "[清理] 删除已合并的修复分支" +``` + +### 3. 版本发布流程 +```bash +# 1. 从trunk创建发布分支 +svn copy trunk branches/release/v1.2.0 -m "[打包] 创建v1.2.0发布分支" + +# 2. 切换到发布分支 +svn checkout branches/release/v1.2.0 + +# 3. 版本号更新和测试 +# 4. 合并到trunk +svn merge branches/release/v1.2.0 trunk +svn commit -m "[打包] 合并v1.2.0发布到trunk" + +# 5. 创建版本标签 +svn copy trunk tags/v1.2.0 -m "[打包] 创建v1.2.0版本标签" + +# 6. 删除发布分支 +svn delete branches/release/v1.2.0 -m "[清理] 删除v1.2.0发布分支" +``` + +### 4. 紧急修复流程 +```bash +# 1. 从最新标签创建热修复分支 +svn copy tags/v1.1.0 branches/hotfix/v1.1.1-紧急修复 -m "[修复] 创建紧急修复分支" + +# 2. 切换到热修复分支 +svn checkout branches/hotfix/v1.1.1-紧急修复 + +# 3. 快速修复并提交 +svn add . +svn commit -m "[修复] 模块名: 紧急修复描述" + +# 4. 合并到trunk和发布分支 +svn merge branches/hotfix/v1.1.1-紧急修复 trunk +svn commit -m "[修复] 合并紧急修复到trunk" + +svn merge branches/hotfix/v1.1.1-紧急修复 branches/release/v1.1.1 +svn commit -m "[修复] 合并紧急修复到发布分支" + +# 5. 创建新版本标签 +svn copy trunk tags/v1.1.1 -m "[打包] 创建v1.1.1版本标签" + +# 6. 删除热修复分支 +svn delete branches/hotfix/v1.1.1-紧急修复 -m "[清理] 删除紧急修复分支" +``` + +## 常用SVN命令速查 + +### 基础操作 +```bash +svn status # 查看工作区状态 +svn add . # 添加所有文件到版本控制 +svn commit -m "提交信息" # 提交变更 +svn update # 更新工作副本 +svn checkout 路径 # 检出工作副本 +``` + +### 分支操作 +```bash +svn copy 源路径 目标路径 -m "说明" # 创建分支或标签 +svn delete 路径 -m "说明" # 删除分支或文件 +svn merge 源路径 目标路径 # 合并分支 +svn switch 路径 # 切换工作副本到不同分支 +``` + +### 查看信息 +```bash +svn log # 查看提交历史 +svn log -v # 查看详细提交历史 +svn log -r 版本号 # 查看指定版本历史 +svn diff # 查看工作区变更 +svn diff -r 版本号 # 查看与指定版本的差异 +svn info # 查看工作副本信息 +``` + +### 版本管理 +```bash +svn list 路径 # 列出目录内容 +svn cat 文件路径 # 查看文件内容 +svn revert 文件路径 # 撤销文件变更 +svn resolved 文件路径 # 标记冲突已解决 +svn cleanup # 清理工作副本 +``` + +### 标签管理 +```bash +svn copy trunk tags/v1.0.0 -m "创建标签" # 创建版本标签 +svn list tags/ # 查看所有标签 +svn copy tags/v1.0.0 trunk -m "回退" # 从标签回退到trunk +``` + +## 注意事项 +- 提交前确保代码通过测试 +- 重要变更需要代码审查 +- 定期清理已合并分支 +- 保持提交历史清晰可追溯 +- 发布前进行充分测试 +- 使用语义化版本号管理版本 +- 合并前解决所有冲突 +- 定期备份重要分支 \ No newline at end of file