# 贡献指南 感谢你对 `@r-utils` 项目的关注!本文档将帮助你了解如何参与项目贡献。 ## 开发环境要求 - Node.js >= 18.12.0 - pnpm 8.15.6 ## 快速开始 ### 1. Fork 并克隆仓库 ```bash # 克隆你 fork 的仓库 git clone https://gitee.com/your-username/r-util-js.git cd r-util-js # 安装依赖 pnpm install ``` ### 2. 创建分支 ```bash # 从 master 分支创建新分支 git checkout -b feat/your-feature-name # 或 git checkout -b fix/your-bug-fix ``` 分支命名规范: - `feat/xxx` - 新功能 - `fix/xxx` - Bug 修复 - `docs/xxx` - 文档更新 - `refactor/xxx` - 代码重构 - `test/xxx` - 测试相关 - `chore/xxx` - 构建/工具相关 ### 3. 开发与测试 ```bash # 构建所有包 pnpm build # 运行测试 pnpm test # 代码检查 pnpm lint # 代码格式化 pnpm format ``` ### 4. 提交代码 本项目使用 **Conventional Commits** 规范,并通过 `commitizen` + `cz-git` 提供交互式提交体验。 #### 使用交互式提交(推荐) ```bash # 暂存你的更改 git add . # 使用交互式提交 pnpm commit ``` 交互式提交会引导你完成以下步骤: 1. **选择提交类型** - feat/fix/docs 等 2. **输入影响范围** - 可选,如 common/vue3/uni-app 3. **输入简短描述** - 必填,简明扼要说明改动 4. **输入详细描述** - 可选,提供更多上下文 5. **是否有破坏性变更** - 如果有,需要详细说明 6. **关联 Issue** - 可选,如 `fix #123` #### 手动提交 如果你熟悉规范,也可以手动提交: ```bash git commit -m "feat(common): 添加新的工具函数" git commit -m "fix(vue3): 修复 mergeClass 类型错误" git commit -m "docs: 更新 README 文档" ``` #### 提交信息格式 ``` ():