diff --git a/AGENTS.md b/AGENTS.md index c96220f..e5818d3 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -43,8 +43,8 @@ - 数据库:表结构优先 Scheme(`app/admin/scheme/`);避免 ENUM;tools:db 用于调试,不用于“设计表结构” - 前端:视图与脚本同名配对(`*.html` + 同名 `*.js`),并按模块维护 `_common.js` -- 配套资源与多端代码:统一放在 `source/`;不影响现有 PHP/ThinkPHP 主工程运行与发布;目录约定与安全要求见 `source/README.md`(禁止提交构建产物、依赖目录等) -- source 下各子工程(客户端、大屏端等):若子工程目录下存在 `AGENTS.md`,则该子工程的规则以该文件为准 +- 主工程之外的配套内容统一放在 `source/`:包括多端代码、子项目工程(可为 PHP 或其他技术栈)、项目资料、附件与部署配套文件;不影响当前主工程运行与发布;目录约定与安全要求见 `source/README.md`(禁止提交构建产物、依赖目录等) +- `source/` 下各子目录(客户端、大屏端、各类子项目等):若目录下存在 `AGENTS.md`,则该子工程规则以该文件为准 - 部署栈模式:`source/stack/` 为模式文件统一目录(含 `default/` 与各模式目录);`default/` 必须与代码库默认行为一致;默认行为相关文件变更时需同步更新 `source/stack/default/` 对应文件 - 命令执行环境:执行 `php think` 命令前,通过 `php think admin:stack:mode current` 检测当前模式;若为 `docker-dev`,所有 `php think` 命令前缀改为 `docker compose exec ulthon_admin`(如 `docker compose exec ulthon_admin php think tools:http:call`);其他模式(default/full/base-build)直接在宿主机执行 `php think`,不做转换 - 权限:基于 `auth` 注解生成节点与鉴权;以角色为中心管理(角色、角色权限、用户角色);命令行使用见技能:[ulthon-permission-cli](./.agents/skills/ulthon-permission-cli/SKILL.md) @@ -119,7 +119,7 @@ ulthon_admin/ ├── view/ # 视图覆盖层 ├── route/ # 路由定义 ├── database/ # 数据库迁移与种子 -├── source/ # 多端客户端代码(uni-app、Vue) +├── source/ # 主工程外内容统一目录(多端代码/资料/附件/各类子项目) │ └── clients/uniapp/ # uni-app 前端工程 └── .agents/ # 智能体技能与规则 ``` diff --git a/source/README.md b/source/README.md index 17075ea..08a15b6 100644 --- a/source/README.md +++ b/source/README.md @@ -1,29 +1,33 @@ # source/ -本目录用于收纳“配套资源与多端代码”,不影响现有 PHP/ThinkPHP 主工程运行与发布。根目录仍是后端工程的唯一入口。 +本目录用于收纳“主工程之外的配套内容”,包括多端代码、各类子项目、资料与附件等,不影响当前主工程运行与发布。根目录仍是主工程入口。 ## 目录约定 - `source/assets/`:通用静态资源(模板、字体、设计稿导出等) - `source/assets/templates/` - `source/assets/fonts/` +- `source/docs/`:项目资料(说明文档、流程文档、交付文档等) +- `source/attachments/`:附件与素材(非代码交付物、原始文件等) - `source/docker/`:附属服务/可选服务编排与开发辅助(与根目录 `docker/` 区分) - `source/clients/`:各端前端/客户端工程 - `source/clients/uniapp/`:uni-app(Vue3 + Vite + JavaScript) - `source/clients/vue-screen/`:预留“大屏端”目录 +- `source/projects/`:各类子项目(可为 PHP 或其他技术栈,如 Python/Go/Node 工具或服务) +- `source/stack/`:部署栈模式文件(`default/` 与各模式目录) ## 命名规则 - 统一小写,使用 `-` 连接(如 `vue-screen`) -- 目录按 `clients / assets / docker` 分类 +- 目录按 `clients / projects / assets / docs / attachments / docker / stack` 分类 ## 依赖与构建产物 - 每个子工程自带依赖清单(例如 `package.json`) - 禁止提交依赖目录与构建产物(例如 `node_modules/`、`dist/`) +- 资料与附件目录建议保留原始格式,避免混入可执行产物或临时缓存 ## 安全约束 - 禁止在该目录提交任何密钥/证书/私有 token - 如需环境变量,提交 `.env.example`,不要提交真实 `.env` -- diff --git a/source/attachments/.gitkeep b/source/attachments/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/source/docs/.gitkeep b/source/docs/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/source/projects/.gitkeep b/source/projects/.gitkeep new file mode 100644 index 0000000..e69de29