Files
skelet/AGENTS.md
T

67 lines
3.3 KiB
Markdown
Raw Normal View History

2026-07-06 10:25:29 +08:00
# AGENTS.md
> Codex / AI coding agent 的仓库级入口。进入本仓库后,先读本文,再进入 [`docs/00-ai-start-here.md`](docs/00-ai-start-here.md)。
## 项目定位
Skelet 是一个介绍、分类、评测开源项目骨架的网站。目标用户是希望用 AI coding 更快启动项目的开发者、独立开发者和小团队。
第一版不是 SaaS 产品,也不是模板市场;它是一个内容和结构化目录优先的网站,帮助用户按“场景”找到合适骨架,再用“语言 / 框架 / AI 友好度”等维度筛选。
## 当前阶段
Phase 2(前台 MVP)完成。T-201 至 T-206 已实现(基础页面框架、首页、场景页、项目列表、筛选搜索、详情页、文章列表与详情)。
2026-07-06 10:25:29 +08:00
下一步:进入 Phase 3,从 [`docs/06-tasks.md`](docs/06-tasks.md) 领取 `T-301`:补 SEO 基础。
2026-07-06 10:25:29 +08:00
2026-07-06 11:32:35 +08:00
## 开发环境
- 当前实际开发环境为 MSYS2 / MinGW(Windows),Python 3.12.12,bash 命令形态。
- WSL2 / Linux 为后续标准开发环境目标;当前 venv 使用 `--system-site-packages`(Pillow 来自 MSYS2 预编译包)。
2026-07-06 11:32:35 +08:00
- 所有文档命令统一使用 bash 形态。
- `init.sh` 是标准启动与验证入口;`init.ps1` 仅作为 Windows 下的可选辅助,允许滞后。
2026-07-06 10:25:29 +08:00
## 必读顺序
2026-07-06 11:32:35 +08:00
本清单是必读顺序的唯一权威版本,其他文档不重复维护。每次开始工作前,按顺序读取:
2026-07-06 10:25:29 +08:00
2026-07-06 11:32:35 +08:00
1. `docs/00-ai-start-here.md`:进入 AI 开发流程。
2. `docs/01-vision.md`:理解为什么做、为谁做、什么不做。
3. `docs/02-requirements.md`:理解 MVP 功能和验收标准。
4. `docs/03-tech-stack.md`:确认 Wagtail / Django / Python / SQLite 选型。
5. `docs/04-architecture.md`:确认系统结构、数据模型、评分维度、开发顺序。
6. `docs/05-coding-rules.md`:确认编码硬规则。
7. `docs/06-tasks.md`:领取唯一任务。
8. `progress.md` 和 `docs/current-state.md`:恢复历史执行和当前快照。
出现失败模式、做阶段性评审或接入已有代码库时,另查 `docs/90-harness-reference.md`。
2026-07-06 10:25:29 +08:00
## 工作规则
- 每轮只做 `docs/06-tasks.md` 中第一个状态为 `TODO` 且依赖均为 `DONE` 的任务。
- 生产代码未初始化前,不要添加业务功能文件,不要伪造可运行状态。
- 任何技术选型变化必须先更新 `docs/03-tech-stack.md` 和 `docs/04-architecture.md`。
- 任何需求范围变化必须先更新 `docs/02-requirements.md`。
- 完成任务前必须运行对应验证命令,并把结果追加到 `progress.md`。
- 任务状态变化必须同步 `docs/06-tasks.md` 和 `docs/current-state.md`。
- 不写真实密钥、账号、token、私有服务地址。
## 默认技术边界
- 第一版使用 Wagtail + Django + Python 3.12 + SQLite。
2026-07-06 11:32:35 +08:00
- 第一版为英文单语言站点(决策依据见 `business/content-strategy.md`)。
2026-07-06 10:25:29 +08:00
- 第一版只需要 Wagtail 管理后台账号,不做前台用户注册。
- 第一版数据库使用 SQLite with JSON1,并启用 WAL 作为上线前建议。
- 第一版部署目标是 2 核 2G VPS。
- 出现高写入功能、用户系统、频繁提交、评论、收藏、会员或 `database is locked` 后,再迁移 PostgreSQL。
## 验证
2026-07-06 11:32:35 +08:00
```bash
.venv/bin/python3.12.exe manage.py check
.venv/bin/python3.12.exe manage.py test
2026-07-06 10:25:29 +08:00
```
`init.sh` 是标准启动与验证入口(`init.ps1` 为 Windows 辅助脚本)。
2026-07-06 10:25:29 +08:00