项目说明
项目概况
- 本项目基于
Cocos Creator 2.4.15开发。 - 主要开发语言为
TypeScript。 - Android 平台使用
Android Studio进行构建。 - iOS 平台使用
Xcode进行构建。
协作约定
- 所有改动应尽量兼容
Cocos Creator 2.4.15的工作流和项目结构。 - 优先遵循仓库现有的 TypeScript 编码风格与目录组织方式。
- 避免引入当前
Cocos Creator 2.4.15环境不支持的工具链、语法或特性。 - 涉及移动端构建调整时,Android 相关改动应保持兼容 Android Studio 工程,iOS 相关改动应保持兼容 Xcode 工程。
构建背景
Cocos Creator是游戏逻辑开发与资源集成的主要编辑环境。- 导出或生成原生工程后,移动端的打包、调试与发布流程继续在
Android Studio和Xcode中完成。
提交约定
- 如果用户输入
commit,默认表示要直接提交当前已暂存的内容 - 只允许基于当前
git add过的 staged diff 整理改动并生成简短 commit message - 默认不要自动把未暂存文件加入提交
- 如果 staged 为空,应明确提示无法提交
- 如果 staged 内容明显混入无关改动,应先提醒用户再决定是否继续提交
- commit message 默认保持简短、直接,优先使用类似
feat: ...、fix: ...、refactor: ...的格式 - 除非用户明确要求,否则不要改写历史,不要
commit --amend,不要执行破坏性 git 操作 - 用中文提交