3步掌握BongoCat贡献指南：让你的创意点亮千万用户的桌面

🌟 为什么BongoCat值得你的贡献

BongoCat不仅仅是一款软件，更是一个让代码充满温度的开源项目。想象一下，当你敲击键盘时，屏幕上那只呆萌的猫咪会同步挥动小爪子回应——这种充满生命力的互动体验，正是全球用户爱上它的原因。作为完全开源的跨平台应用，BongoCat尊重用户隐私（完全离线运行），支持Windows/macOS/Linux系统，并允许每个人创造独一无二的猫咪形象。

加入我们，你将获得：

• 零门槛参与开源的宝贵经验
• 与全球开发者协作的机会
• 看到自己的创意被 thousands 用户使用的成就感

图：用户自定义的BongoCat键盘互动形象，展示社区创作成果

🚀 3步开启你的贡献之旅

1️⃣ 准备开发环境：10分钟快速上手

准备工具
只需安装三个必备工具：

• Rust：后端开发基础
• Node.js：前端运行环境
• Pnpm：高效包管理工具

获取代码

git clone https://gitcode.com/gh_mirrors/bong/BongoCat
cd BongoCat
pnpm install

启动开发模式

pnpm tauri dev

现在你已经成功运行BongoCat开发版，修改代码会实时反映在应用中！

2️⃣ 选择贡献方式：找到你的舒适区

零基础友好型贡献

• 改进文档或翻译：locales/目录包含多语言文件，添加新语言或优化现有翻译
• 反馈使用体验：通过Issue分享你的使用感受和改进建议
• 设计素材贡献：创作猫咪表情、背景图片等资源

技术开发型贡献

• 前端界面优化：src/components/目录下的Vue组件
• 功能扩展：src/composables/目录包含各种交互逻辑
• 跨平台适配：src-tauri/src/core/setup/目录处理平台特定代码

创意设计型贡献

• 自定义模型：src-tauri/assets/models/目录存放标准/键盘/游戏手柄三种模型
• 动作设计：创建猫咪新动作（.motion3.json文件）
• 主题开发：通过src/assets/css/自定义应用样式

图：游戏手柄模式下的BongoCat互动效果，展示多场景应用可能

3️⃣ 提交你的贡献：从构思到合并

创建 Issue
在开始前，先在项目Issues中创建或认领任务，描述你的想法和计划，避免重复工作。

开发与测试

• 遵循代码规范：使用ESLint检查前端代码，Rustfmt格式化后端代码
• 测试跨平台兼容性：至少在一种系统上验证功能正常

提交PR

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

然后在项目页面创建Pull Request，我们会在48小时内回复你的贡献！

🎨 个性化贡献：释放你的创意

定制专属猫咪模型

BongoCat最迷人的特色就是支持自定义模型，即使没有编程经验也能参与：

1. 准备素材：绘制猫咪形象（推荐1024x512像素）
2. 格式转换：使用在线转换工具生成模型文件
3. 放置文件：将模型文件放入src-tauri/assets/models/对应目录
4. 测试效果：在应用设置中切换并预览你的模型

模型目录结构：

• standard/：标准静态模型
• keyboard/：键盘互动模型
• gamepad/：游戏手柄互动模型

图：BongoCat键盘互动模式布局，展示可定制的交互区域

👥 社区协作：与全球开发者共成长

连接BongoCat社区

• 交流群组：通过项目README中的二维码加入QQ交流群
• 贡献者榜单：活跃贡献者将出现在项目贡献排行榜
• 定期活动：参与季度模型设计大赛，赢取专属周边

贡献者成长路径

入门级（1-3个月）

• 完成文档翻译或错误修复
• 设计简单的猫咪表情或背景
• 参与Issue讨论和测试

进阶级（3-6个月）

• 开发新的交互功能
• 创建完整的自定义模型
• 优化跨平台兼容性

专家级（6个月以上）

• 主导新功能模块设计
• 参与架构决策和代码审查
• 指导新贡献者

图：游戏手柄互动模式布局设计，展示社区共创的界面规划

📝 贡献规范速查表

Commit消息格式

• feat: 新功能（如"feat: 添加键盘快捷键支持"）
• fix: 修复bug（如"fix: 解决Linux下窗口闪烁问题"）
• docs: 文档更新（如"docs: 完善模型定制指南"）
• style: 代码风格调整（不影响功能）
• refactor: 代码重构

常用命令

• 开发模式：pnpm tauri dev
• 打包应用：pnpm tauri build
• 代码检查：pnpm lint

---

无论你是编程新手、设计爱好者还是资深开发者，BongoCat都欢迎你的加入！每一个小小的改进，都能让这只可爱的猫咪陪伴更多人的日常工作。现在就克隆项目，开始你的第一次贡献吧——世界正期待你创造的独特猫咪形象！

提示：项目贡献指南会定期更新，最新信息请查看项目根目录的CONTRIBUTING.md文件。