贡献指南

感谢你对 BreezeUI 的关注！本指南说明如何在本仓库进行开发、提交贡献，以及合并与发布前会执行哪些检查。

你可以贡献什么

• 组件功能与 Bug 修复：packages/vue
• 文档页面与示例：packages/docs
• 本地演示：packages/playground

环境要求

• Node.js 18+
• pnpm（本仓库为 pnpm workspace）

快速开始

pnpm install

# 启动文档站点（VitePress）
pnpm run docs:dev

# 启动 playground（用于本地调试组件）
pnpm run dev

项目结构

• packages/vue：组件库源码
• packages/docs：文档站点（英文 /，中文 /zh/）
• packages/playground：组件演示与调试入口

组件开发建议

1. 在 packages/vue/src/<component>/ 内开发或修复
2. 新增组件时确保在 packages/vue/src/index.ts 完成导出
3. 在 playground 里联调验证：pnpm run dev

文档编写建议

• 英文：packages/docs/guide/*、packages/docs/components/*
• 中文：packages/docs/zh/guide/*、packages/docs/zh/components/*
• 本地预览：pnpm run docs:dev

代码规范与检查

项目使用 ESLint + Prettier。你可以在提交前手动执行：

pnpm run lint
pnpm run format

测试与类型检查

pnpm run test
pnpm run test:watch
pnpm run type-check
pnpm run build

Git Hooks（Husky）

• pre-commit：运行 lint-staged，检查并格式化暂存区文件
• pre-push：运行单元测试与类型检查
• development 分支：为快速迭代会跳过以上检查

PR 流程

• 从主分支拉出功能分支并提交 PR
• 组件改动尽量同步补齐文档与示例
• 请求评审前确保 lint、type-check、test、build 通过

发包说明（维护者）

• 本地发布会执行 prepublishOnly（测试 + 构建）作为发布前门禁。
• CI 发包在 push 到 master 时触发，且仅当相关包 package.json 的 version 发生变化才会发布；提交信息包含 skip ci 会跳过发布。