17 lines
2.3 KiB
Markdown
17 lines
2.3 KiB
Markdown
# Repository Guidelines
|
||
|
||
## 项目结构与模块组织
|
||
本仓库是 `Cocos Creator 3.8.8` 小游戏项目。主入口在 `assets/main.ts`，主场景是 `assets/main.scene`。页面与弹窗组件集中在 `assets/prefabs/`，命名通常为 `PageXxx.ts`、`PassModal.ts`。公共逻辑位于 `assets/scripts/`：`core/` 放页面基类与视图管理，`utils/` 放 SDK、鉴权、存储、网络等工具，`config/` 放接口配置，`types/` 放类型定义。静态资源在 `assets/resources/`，编辑器配置在 `settings/v2/packages/`，设计说明在 `docs/` 与根目录分析文档中。
|
||
|
||
## 构建、调试与开发命令
|
||
先运行 `npm install`，同步 `minigame-api-typings` 依赖。日常开发主要通过 Cocos Creator 编辑器完成：使用 3.8.8 打开仓库，点击 `Play` 预览，使用 `Project > Build` 或 `Cmd+B` 构建小游戏包。若编辑器已生成 `temp/tsconfig.cocos.json`，可执行 `npx tsc --noEmit` 做一次 TypeScript 静态检查。
|
||
|
||
## 代码风格与命名约定
|
||
项目使用 TypeScript，当前代码统一为 4 空格缩进。组件类、页面类、管理器类使用 `PascalCase`，实例属性与私有方法使用 `camelCase` / `_camelCase`，管理器统一使用 `XxxManager` 后缀。新增页面、预制体、脚本请保持同名，例如 `PageLevel.prefab` 对应 `PageLevel.ts`。优先把复用逻辑放入 `assets/scripts/utils/` 或 `assets/scripts/core/`，不要把业务代码散落到场景脚本中。Cocos 资源的 `.meta` 文件必须一并提交。
|
||
|
||
## 测试与验证
|
||
仓库当前未配置 Jest、Vitest 一类自动化测试。提交前至少完成三项验证：1. 编辑器预览主流程可进入页面；2. 目标平台构建成功；3. 涉及微信能力时，在真机或开发者工具验证登录、分享、隐私授权等流程。若修改接口或体力/关卡逻辑，补充手动验证步骤到 PR 描述。
|
||
|
||
## 提交与 Pull Request 规范
|
||
Git 历史采用 Conventional Commits，且摘要多为中文，例如 `feat: 支持分享关卡通关上报`、`fix: 修复关卡排序`、`docs: 添加设计文档`。请继续使用 `feat:`、`fix:`、`perf:`、`docs:` 前缀，首行聚焦单一变更。PR 需说明改动范围、影响页面或模块、验证方式；涉及 UI 请附截图或录屏，涉及微信环境差异请写明复现条件与平台。
|