docs:创建git提交指导文档与命名规则指导文档,更新readme内容

This commit is contained in:
2025-12-08 16:14:15 +08:00
parent 5acfa7f42b
commit 4285b25323
3 changed files with 798 additions and 0 deletions

View File

@@ -43,6 +43,55 @@ whaleTown/
- **资源文件**: 图片、音频等资源存放在 `assets/` 目录
- **游戏数据**: 配置文件、关卡数据等存放在 `data/` 目录
### 命名规范
本项目遵循统一的命名规范以保持代码一致性:
**核心规则**
- **场景文件**`下划线_scene.tscn``下划线_prefab.tscn`
- 示例:`main_scene.tscn``player_prefab.tscn`
- **脚本文件**`PascalCase.gd`(大驼峰)
- 示例:`PlayerController.gd``UI_MainMenu.gd`
- **节点名称**`camelCase`(小驼峰)
- 示例:`playerHpBar``startButton`
- **变量/函数**`camelCase`(小驼峰)
- 示例:`var moveSpeed``func getPlayerPos()`
- **常量**`UPPER_CASE`(全大写 + 下划线)
- 示例:`const MAX_HEALTH = 100`
- **资源文件**`lower_case`(小写 + 下划线)
- 示例:`bg_main_menu.png``sound_jump.wav`
📖 查看完整的 [命名规范文档](docs/naming_convention.md)
### Git 提交规范
本项目遵循统一的 Git 提交信息格式:`<类型><描述>`
**常用提交类型**
- `init`:项目初始化
- `feat`:新增功能
- `fix`:修复 Bug
- `docs`:文档更新
- `scene`:场景文件相关
- `asset`:资源文件相关
- `ui`UI 界面相关
- `gameplay`:游戏玩法相关
- `refactor`:代码重构
- `perf`:性能优化
**提交示例**
```bash
git commit -m "init项目初始化搭建Godot文件结构"
git commit -m "feat实现玩家角色的移动和跳跃"
git commit -m "fix修复敌人穿墙的碰撞问题"
git commit -m "scene创建战斗场景并配置相机"
```
📖 查看完整的 [Git 提交规范文档](docs/git_commit_guide.md)
## 贡献
欢迎提交 Issue 和 Pull Request