feat: 引入 Wiki 文档镜像流程 (#1)
This commit is contained in:
+37
-19
@@ -1,23 +1,32 @@
|
||||
<!-- gitea-wiki-mirror:start -->
|
||||
generated: true (请先修改 Gitea Wiki,禁止直接编辑本文件)
|
||||
wiki_page: Project-Profile
|
||||
wiki_url: http://ilaer.eicp.net:8418/opc/dev_harness/wiki/Project-Profile.-
|
||||
wiki_revision: 845266496196a4fc33462dfda779d0f899fa4c18
|
||||
synchronized_at: 2026-08-07T15:53:58Z
|
||||
<!-- gitea-wiki-mirror:end -->
|
||||
|
||||
# 项目档案
|
||||
|
||||
复制模板后先填写本页。这里保存不经常变化、所有维护者都需要知道的信息。
|
||||
本页记录不经常变化、所有维护者都需要知道的信息。它是项目档案的事实来源;仓库内 `docs/00-project-profile.md` 是只读镜像。
|
||||
|
||||
## 基本信息
|
||||
|
||||
| 项目 | 内容 |
|
||||
|---|---|
|
||||
| 项目名称 | `<填写>` |
|
||||
| 一句话目标 | `<填写>` |
|
||||
| Gitea 地址 | `<例如 https://gitea.example.com>` |
|
||||
| 仓库 | `<owner/repository>` |
|
||||
| 项目名称 | DevHarness |
|
||||
| 一句话目标 | 提供以 Gitea 工单、Wiki 和 Git 为事实来源的 AI 辅助开发工作流模板 |
|
||||
| Gitea 地址 | http://ilaer.eicp.net:8418 |
|
||||
| 仓库 | `opc/dev_harness` |
|
||||
| 默认分支 | `main` |
|
||||
| 主要维护者 | `<填写>` |
|
||||
| 主要维护者 | `ila` |
|
||||
|
||||
## 技术栈
|
||||
|
||||
| 部分 | 技术 | 规则文件 |
|
||||
|---|---|---|
|
||||
| `<子项目或服务>` | `<语言、框架、版本>` | `<路径/AGENTS.md>` |
|
||||
| Harness 规则和模板 | Markdown、Gitea | `AGENTS.md` |
|
||||
| Wiki 镜像与结构检查 | Python 3 标准库 | `AGENTS.md` |
|
||||
|
||||
## 常用命令
|
||||
|
||||
@@ -25,26 +34,35 @@
|
||||
|
||||
| 用途 | 命令 | 预期结果 |
|
||||
|---|---|---|
|
||||
| 安装依赖 | `<填写>` | `<填写>` |
|
||||
| 启动开发环境 | `<填写>` | `<填写>` |
|
||||
| 格式检查 | `<填写>` | `<填写>` |
|
||||
| 静态检查 | `<填写>` | `<填写>` |
|
||||
| 单元测试 | `<填写>` | `<填写>` |
|
||||
| 集成测试 | `<填写或写“不适用”>` | `<填写>` |
|
||||
| 检查模板结构 | `python scripts/check_harness.py --strict` | 输出“DevHarness 检查通过” |
|
||||
| 运行单元测试 | `python -m unittest discover -s tests -v` | 所有测试通过 |
|
||||
| 导出 Wiki 镜像 | `python scripts/sync_wiki_docs.py` | 映射页面写入 `docs/` |
|
||||
| 检查 Wiki 镜像 | `python scripts/sync_wiki_docs.py --check` | 输出镜像与 Wiki 一致 |
|
||||
| 创建任务归档 | `python scripts/new_task_archive.py 123 "修复登录超时"` | 先创建 Wiki 归档页,再登记并导出本地镜像 |
|
||||
|
||||
## 目录边界
|
||||
|
||||
| 目录 | 职责 | 不应放入 |
|
||||
|---|---|---|
|
||||
| `<路径>` | `<填写>` | `<填写>` |
|
||||
| `.gitea/issue_template/` | Gitea 工单模板 | 凭据、任务最终归档 |
|
||||
| `docs/` | Wiki 自动导出的只读镜像 | 人工直接维护的长期文档 |
|
||||
| `docs/task/` | Wiki 任务归档页的只读镜像 | 讨论过程和临时方案 |
|
||||
| `scripts/` | Harness 检查、Wiki 同步和归档工具 | 产品功能代码 |
|
||||
| `tests/` | Harness 工具自动化测试 | 生产数据 |
|
||||
|
||||
## 环境与凭据
|
||||
|
||||
- 本地配置文件:`<填写>`
|
||||
- 配置示例文件:`<填写>`
|
||||
- 凭据保存位置:`<只写保存方式,不填写真实凭据>`
|
||||
- 日志和构建产物位置:`<填写>`
|
||||
- Wiki 同步配置:仓库根目录 `wiki-docs.json`。
|
||||
- Gitea 地址可由配置提供,也可通过 `GITEA_URL` 覆盖。
|
||||
- Gitea Personal Access Token 仅通过 `GITEA_TOKEN` 环境变量提供,不写入仓库。
|
||||
- Token 至少需要读取仓库权限;创建 Wiki 任务归档时还需要写仓库权限。
|
||||
- 日志和构建产物:本项目不持久化运行日志;Python 缓存不提交。
|
||||
|
||||
## 项目专用验收要求
|
||||
|
||||
- `<填写>`
|
||||
- 长期文档必须先更新 Wiki,再导出本地镜像。
|
||||
- 镜像必须包含来源页面、revision 和同步时间。
|
||||
- 页面删除、重命名和映射变更必须人工确认。
|
||||
- `python scripts/check_harness.py --strict` 必须通过。
|
||||
- `python -m unittest discover -s tests -v` 必须通过。
|
||||
- 未执行或无法覆盖的验证必须记录到工单。
|
||||
|
||||
Reference in New Issue
Block a user