# 贡献指南

感谢你愿意为桌宠小鲸鱼出力。在动手之前，请先看一眼这个项目的范围。

## 这个项目的定位

**只维护，充当基底。**

以修 bug 和保持兼容为主。

## 欢迎的改动

- **bug 修复**
- **性能改进**
- **让小鲸鱼更好的小改动**（新表情、新小动作、新配色这类，先开 issue 说一声）
- **开发体验**（测试、检查脚本、构建）
- **文档、注释、翻译**
- **兼容性适配**（DSH 版本更新导致的失效）

## 不接受的改动

- **新宠物、新角色** —— 小鲸鱼就是这个项目本身
- **新玩法、新模式** —— 桌宠之外的东西
- **架构重构**

这类改动非常欢迎你在自己的 fork 里做。做好之后开一个 issue 贴上链接，我会在
README 的「社区 fork」里挂出来，让需要的人能找到。

## 提 PR 的几条约定

1. **一个 PR 一件事**。bug 修复和重构请分开提，方便我分别判断
2. **超过 300 行改动，请先开 issue 讨论**
3. **PR 正文写清楚**：解决什么问题、怎么验证的
4. 涉及第三方角色或素材的改动，请写明来源与非商业性质，别把原作美术 / 音频放进仓库
5. 提交前跑一遍：

   ```sh
   pnpm typecheck && pnpm test && pnpm build
   ```