Skip to content

docs: 添加开发工作流说明 - #16

Merged
maplezzk merged 1 commit into
mainfrom
docs/add-development-workflow
Feb 1, 2026
Merged

maplezzk merged 1 commit into
mainfrom
docs/add-development-workflow

Conversation

@maplezzk

@maplezzk maplezzk commented Feb 1, 2026

Copy link
Copy Markdown
Owner

功能概述

为项目添加完整的开发工作流文档,帮助新贡献者快速上手项目开发。

主要变更

  • ✨ 新增环境准备章节(前置要求、克隆项目、安装依赖)
  • ✨ 新增本地开发指南(dev、build、test 命令说明)
  • ✨ 新增提交规范(Conventional Commits 格式)
  • ✨ 新增完整的 PR 流程说明(分支命名、提交流程、检查清单)
  • ✨ 新增发布流程说明(自动化发布、版本号规则)
  • ✨ 新增 CI/CD 工作流介绍
  • ✨ 新增代码规范和项目结构说明
  • ✨ 新增开发常见问题解答

文档内容

开发工作流章节包含:

  1. 环境准备 - 项目设置和依赖安装
  2. 本地开发 - 开发模式、构建、运行
  3. 测试 - 测试命令和要求
  4. 提交规范 - Conventional Commits 格式和类型
  5. PR 流程 - 完整的从分支创建到合并的流程
  6. 发布流程 - 自动化发布机制和版本管理
  7. CI/CD - 持续集成和持续部署说明
  8. 代码规范 - TypeScript、代码风格、项目结构
  9. 开发常见问题 - 调试、测试失败处理等

适用对象

  • 新加入项目的贡献者
  • 需要参与开发的维护者
  • 需要了解项目发布流程的团队成员

🤖 Generated with Claude Code

新增内容:
- 环境准备和项目设置
- 本地开发指南(dev、build、test)
- 提交规范(遵循 Conventional Commits)
- 完整的 PR 流程说明
- 自动化发布流程说明
- CI/CD 工作流介绍
- 代码规范和项目结构
- 开发常见问题解答

帮助新贡献者快速上手项目开发。

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@maplezzk
maplezzk merged commit 489138b into main Feb 1, 2026
1 check passed
@maplezzk
maplezzk deleted the docs/add-development-workflow branch February 2, 2026 14:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant