BongoCat贡献指南：从代码到创意的全方位参与手册

BongoCat是一款让呆萌可爱的猫咪陪伴你键盘敲击与鼠标操作的跨平台应用，支持Windows、macOS和Linux系统。作为完全开源项目，它不仅代码透明、尊重隐私，还允许用户导入自定义模型，打造专属猫咪形象。无论你是开发者、设计师还是文档爱好者，都能在这个项目中找到适合自己的贡献方式，让我们一起打造更棒的BongoCat！

价值定位：为什么贡献BongoCat

项目价值：重新定义人机交互体验

BongoCat通过Tauri框架（一种轻量级跨平台应用开发工具）实现了三大核心价值：

• 隐私优先：完全离线运行，不收集任何用户数据，让用户安心使用
• 跨平台兼容：完美适配macOS、Windows和Linux(x11)系统，覆盖主流桌面平台
• 高度自定义：支持导入自定义模型，让每个用户都能拥有独一无二的猫咪形象

图：BongoCat键盘互动模式下的可爱猫咪形象，展示了项目的核心视觉风格

个人成长：在开源中提升多维度能力

参与BongoCat贡献将为你带来多方面成长：

• 技术栈拓展：掌握Rust+TypeScript+Tauri的现代跨平台开发技术栈
• 项目经验积累：参与真实开源项目的完整生命周期，从需求分析到代码提交
• 社区影响力：你的贡献将被全球用户看见和使用，建立个人技术品牌

[!TIP] 即使你是开源新手也不必担心，我们欢迎所有技能水平的贡献者，从修复拼写错误到实现新功能，每一份贡献都很重要！

快速上手：3步开启贡献之旅

环境准备：开发工具清单

在开始贡献前，请确保你的开发环境满足以下要求：

• 基础工具：

  • Rust：用于Tauri后端开发（建议1.60+版本）
  • Node.js：运行前端环境（建议16.x+版本）
  • Pnpm：包管理工具（建议7.x+版本）

• 环境验证清单：

  # 验证Rust安装
  rustc --version
  
  # 验证Node.js安装
  node --version
  
  # 验证Pnpm安装
  pnpm --version
  

[!TIP] 如果你在环境搭建过程中遇到问题，可以查看项目的常见问题速查文档，或在社区中寻求帮助。

项目获取与构建

📌 第一步：克隆项目仓库

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

📌 第二步：安装项目依赖

pnpm install

📌 第三步：启动开发模式

pnpm tauri dev

当你看到可爱的BongoCat出现在屏幕上时，说明开发环境已经成功搭建！

图：BongoCat游戏手柄互动模式界面，展示了不同输入设备下的猫咪互动效果

常见问题速查

• 构建失败：检查Rust和Node.js版本是否符合要求，运行pnpm install确保依赖安装完整
• 界面显示异常：尝试删除node_modules目录后重新安装依赖
• 模型加载问题：确认模型文件路径正确，检查控制台输出的错误信息

深度参与：三大贡献路径

代码贡献：从修复到创新

代码贡献是BongoCat项目发展的核心动力，无论你是修复一个bug还是实现一个全新功能，都能为项目带来价值。

贡献流程

1. 寻找贡献点：浏览项目的Issue列表，寻找标记为"good first issue"的任务
2. 创建分支：从main分支创建功能分支，命名格式建议为feature/功能名称或fix/bug描述
3. 开发实现：遵循项目代码规范进行开发，编写必要的测试
4. 提交PR：创建Pull Request，详细描述你的修改内容和解决的问题

代码规范

• Commit消息：遵循conventional-changelog 标准，如feat: 添加游戏手柄支持或fix: 修复键盘响应延迟问题
• 代码风格：前端遵循ESLint配置，后端遵循Rustfmt规范
• 测试要求：新功能需包含单元测试，确保代码质量

[!TIP] 核心代码目录说明：

• src/：前端Vue代码
• src-tauri/src/：Rust后端代码
• src-tauri/assets/models/：模型资源文件

创意贡献：打造独特猫咪形象

BongoCat的魅力很大程度上来自于可爱的猫咪形象，如果你擅长设计或3D建模，创意贡献是你参与项目的绝佳方式。

模型定制指南

1. 模型格式要求：支持Live2D Cubism 3.x/4.x格式，包含.moc3、.model3.json等文件

2. 模型目录结构：

   src-tauri/assets/models/
   ├── standard/    # 标准模型
   ├── keyboard/    # 键盘互动模型
   └── gamepad/     # 游戏手柄互动模型
   

3. 提交新模型：将你的模型文件组织成上述结构，创建PR说明模型特点和使用场景

图：BongoCat键盘互动模式的背景布局，可作为模型设计的参考

创意资源贡献

除了模型外，你还可以贡献：

• 猫咪动作设计（.motion3.json文件）
• 表情动画（.exp3.json文件）
• 界面主题和背景图片

文档贡献：让项目更易上手

优质的文档是项目发展的重要基石，如果你擅长写作或技术文档整理，欢迎参与文档贡献。

文档贡献方向

• 完善教程：编写新手指南、高级功能教程等
• 翻译文档：将现有文档翻译成其他语言
• API文档：完善前端和后端API文档
• 使用案例：分享BongoCat的创意使用方式

文档规范

• 使用Markdown格式编写
• 遵循项目现有文档风格
• 技术术语首次出现时提供解释
• 包含必要的截图和示例代码

社区生态：与开发者伙伴共同成长

社区交流渠道

加入BongoCat社区，与开发者伙伴交流经验、解决问题：

• 讨论区：项目仓库的Discussions板块
• 即时通讯：通过项目README中的二维码加入QQ群
• 贡献者会议：定期线上会议，讨论项目进展和未来规划

贡献者激励

• 贡献者名单：你的名字将出现在项目的贡献者名单中
• 技术影响力：参与开源项目提升个人技术影响力
• 技能提升：获得社区反馈，不断提升开发技能

图：BongoCat游戏手柄互动模式的背景布局，展示了项目的多设备支持能力

长期贡献者计划

对于持续为项目做出贡献的开发者，将有机会成为项目维护者，参与项目决策和方向规划。我们相信，开源的力量来自于社区的共同努力，每一位贡献者都是BongoCat成长的重要力量。

总结：开始你的BongoCat贡献之旅

通过本指南，你已经了解了BongoCat的贡献价值、快速上手方法、深度参与路径和社区生态。无论你是经验丰富的开发者还是刚入门的新手，都能在BongoCat项目中找到适合自己的贡献方式。

现在就行动起来：

1. 克隆项目仓库
2. 选择一个贡献方向
3. 创建你的第一个PR
4. 加入社区与我们交流

让我们一起打造更可爱、更强大的BongoCat，让更多用户享受猫咪陪伴的乐趣！

注：本文档将定期更新，最新贡献指南请参考项目仓库中的贡献指南文件。