NLDClient-yudde/ProjectNLD/AGENTS.md

42 lines
2.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# AGENTS.md
# 在执行大量代码修改之前,先和用户确认设计思路再继续执行
# 编码要求
使用面向对象的设计思路
单个文件/模块尽可能小且功能单一
## 一般准则
- 按要求去做,不扩展额外的功能
- 不要生成unity的meta文件留给unity自己生成
- 不要主动编译项目, 这是一个unity项目, unity会自动进行编译, 如果有编译错误用户会自主拷贝给你, 但是你可以做自己的静态代码检查
- 如果有疑问主动向用户确认
- 除非用户要求特别清晰,开始编码行为之前,将你的计划描述给用户并获得用户确认后才开始行动收集信息等操作或者编写plan不用
## 图片资源处理
- 当任务涉及设计图片资源(如 UI 贴图、图标、背景图等AI 可以自主决定是否查看图片内容,以获取更多有用信息(如尺寸、颜色、布局、风格等),从而更好地完成任务
## 编辑器开发
- 使用Odin工具开发编辑器
## git操作
- 除非用户要求,AI不做任何git提交相关操作
- 当用户让AI操作git时提醒用户git操作有风险
- **重要**:本项目有三个关联的 Git 仓库(见下方"项目仓库结构"),任何 git 操作pull/push/commit/checkout 等)都必须同时考虑三个仓库的同步对齐,务必读取 `batch-git-ops` skill 后按其流程执行
## 项目仓库结构
本项目包含三个独立的 Git 仓库,路径相对于 workspace 根目录ProjectNLD
| 仓库 | 相对路径 | 定位 |
|------|---------|------|
| **NLDClient** | `../../` | 游戏客户端主仓库,包含 Unity 项目配置、资源、框架代码等 |
| **NLDMisc** | `../../../NLDMisc` | 配置表相关仓库,存放游戏参数、数值配置等数据 |
| **GamePlay** | `Assets/Code/Scripts/GamePlay` | 核心游戏逻辑代码仓库,编译产物为 `GamePlay_Dll/GamePlay.dll` |
- 执行 git 操作时必须明确区分当前操作的是哪个仓库,不要混淆仓库边界
- 查找或修改代码时注意文件属于哪个仓库,避免在错误的仓库中操作
# 其他
- `Assets/Code/Scripts/GamePlay_Dll/GamePlay.dll` 对应的源码仓库在 `Assets/Code/Scripts/GamePlay` 中(独立 Git 仓库)
- 不要主动编译项目, 这是一个unity项目, unity会自动进行编译, 如果有编译错误用户会自主拷贝给你, 但是你可以做自己的静态代码检查