开源贡献

贡献指南

感谢您对VibeCLI项目的关注！无论是代码贡献、文档改进还是问题反馈，每一份贡献都让项目变得更好

欢迎加入VibeCLI开源社区！

VibeCLI是一个由社区驱动的开源项目，我们相信每个人都可以为AI驱动的开发工具做出贡献。无论你是经验丰富的开发者还是刚开始学习编程，都有适合你的贡献方式。

访问GitHub仓库联系维护者

贡献方式

多种方式参与项目，找到最适合你的贡献方式

代码贡献

提交代码、修复Bug、新增功能

主要活动：

修复已知Bug和问题

实现新功能和改进

优化性能和代码质量

添加单元测试和集成测试

改进TypeScript类型定义

重构和代码清理

技能要求：

熟悉TypeScript/JavaScript

了解React和Next.js

遵循项目代码规范

编写清晰的提交信息

文档改进

改进文档、教程、API说明

主要活动：

修正文档中的错误

改进API文档说明

编写使用教程和示例

翻译文档到其他语言

优化文档结构和导航

添加代码示例和截图

技能要求：

良好的中英文写作能力

熟悉Markdown语法

了解VibeCLI使用方法

注重用户体验

问题反馈

报告Bug、提出改进建议

主要活动：

报告Bug和异常行为

提出功能改进建议

反馈用户体验问题

测试新版本功能

参与问题讨论

验证修复效果

技能要求：

详细描述问题现象

提供复现步骤

包含环境信息

使用合适的标签

社区建设

参与讨论、帮助他人、推广项目

主要活动：

回答用户问题

参与社区讨论

组织线上/线下活动

制作教学视频

撰写技术博客

推广项目到社交媒体

技能要求：

热心帮助他人

良好的沟通能力

熟悉VibeCLI功能

积极参与社区

开发流程

标准的GitHub贡献流程，确保代码质量和协作效率

1
1. Fork 仓库

在GitHub上Fork VibeCLI仓库到你的账户

访问 https://github.com/vibetemplate/vibecli
点击右上角的 "Fork" 按钮
选择你的GitHub账户

2
2. 克隆代码

将Fork的仓库克隆到本地开发环境

git clone https://github.com/your-username/vibecli.git
cd vibecli
npm install

3
3. 创建分支

为你的贡献创建一个新的功能分支

git checkout -b feature/your-feature-name
# 或者
git checkout -b fix/issue-number

4
4. 开发和测试

进行代码开发并确保测试通过

npm run dev  # 启动开发服务器
npm run test # 运行测试
npm run lint # 检查代码规范

5
5. 提交代码

使用规范的提交信息提交你的更改

git add .
git commit -m "feat: add new feature description"
git push origin feature/your-feature-name

6
6. 创建PR

在GitHub上创建Pull Request

访问你Fork的仓库页面
点击 "Compare & pull request"
填写PR标题和描述

提交规范

使用约定式提交格式，保持项目历史清晰

Conventional Commits 格式

遵循标准化的提交信息格式：type(scope): description

feat

新功能

feat: 添加项目模板生成功能

fix

修复Bug

fix: 修复部署配置错误问题

docs

文档更新

docs: 更新API文档示例

style

代码格式

style: 修复代码缩进问题

refactor

代码重构

refactor: 重构工具调用逻辑

test

测试相关

test: 添加单元测试用例

chore

构建过程

chore: 更新依赖包版本

代码规范

保持代码质量和一致性的编码标准

TypeScript

所有函数都要有明确的类型定义

使用interface定义复杂对象类型

避免使用any类型，优先使用unknown

启用strict模式进行类型检查

React/Next.js

优先使用函数组件和Hooks

合理使用useCallback和useMemo

组件名使用PascalCase命名

文件名使用kebab-case命名

代码风格

使用Prettier格式化代码

遵循ESLint规则配置

函数长度不超过50行

添加必要的注释说明

测试

新功能必须包含测试用例

测试覆盖率保持在80%以上

使用描述性的测试名称

模拟外部依赖和API调用

贡献者认可

感谢每一位贡献者，我们为优秀的贡献提供认可和奖励

Contributor

代码贡献者

认定标准：

• 提交至少1个PR被合并

• 遵循项目规范

奖励权益：

✓ GitHub贡献者列表

✓ 项目README致谢

Active Contributor

活跃贡献者

认定标准：

• 提交5个以上PR被合并

• 参与Issue讨论

• 帮助其他开发者

奖励权益：

✓ 特殊徽章

✓ 优先Review

✓ 技术分享机会

Core Contributor

核心贡献者

认定标准：

• 长期持续贡献

• 代码质量优秀

• 积极参与项目决策

奖励权益：

✓ Commit权限

✓ 技术咨询机会

✓ 项目路线图参与

准备开始贡献？

查看GitHub仓库中的Issues，找到感兴趣的任务开始你的贡献之旅。如果有任何问题，随时联系我们获取帮助。

查看Issues 加入讨论阅读文档

贡献指南

欢迎加入VibeCLI开源社区！

贡献方式

代码贡献

主要活动：

技能要求：

文档改进

主要活动：

技能要求：

问题反馈

主要活动：

技能要求：

社区建设

主要活动：

技能要求：

开发流程

11. Fork 仓库

22. 克隆代码

33. 创建分支

44. 开发和测试

55. 提交代码

66. 创建PR

提交规范

Conventional Commits 格式

代码规范

TypeScript

React/Next.js

代码风格

测试

贡献者认可

Contributor

认定标准：

奖励权益：

Active Contributor

认定标准：

奖励权益：

Core Contributor

认定标准：

奖励权益：

准备开始贡献？

1
1. Fork 仓库

2
2. 克隆代码

3
3. 创建分支

4
4. 开发和测试

5
5. 提交代码

6
6. 创建PR