opc/dev_harness
2
0
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: 扩展项目档案交接信息 (#2)

ila
2026-08-08 08:57:20 +08:00
parent 6cd3fccc78
commit df33a1ce9d
1 changed files with 26 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Project-Profile.-.md
+26 -6
@@ -8,17 +8,31 @@
|---|---| |---|---|
| 项目名称 | DevHarness | | 项目名称 | DevHarness |
| 一句话目标 | 提供以 Gitea 工单、Wiki 和 Git 为事实来源的 AI 辅助开发工作流模板 | | 一句话目标 | 提供以 Gitea 工单、Wiki 和 Git 为事实来源的 AI 辅助开发工作流模板 |
| 主要使用者 | 项目负责人、Claude/Codex Agent、接手简单维护的初级程序员 |
| Gitea 地址 | http://ilaer.eicp.net:8418 | | Gitea 地址 | http://ilaer.eicp.net:8418 |
| 仓库 | `opc/dev_harness` | | 仓库 | `opc/dev_harness` |
| 默认分支 | `main` | | 默认分支 | `main` |
| 主要维护者 | `ila` | | 主要维护者 | `ila` |
| 文档适用范围 | 默认分支当前版本；具体镜像 revision 见每个本地文件头 |
## 技术栈 ## 技术栈与运行环境
| 部分 | 技术 | 规则文件 | | 部分 | 技术 | 规则文件 |
|---|---|---| |---|---|---|
| Harness 规则和模板 | Markdown、Gitea | `AGENTS.md` | | Harness 规则和模板 | Markdown、Gitea 1.25 | `AGENTS.md` |
| Wiki 镜像与结构检查 | Python 3 标准库 | `AGENTS.md` | | Wiki 镜像与结构检查 | Python 3 标准库 | `AGENTS.md` |
| 主要开发环境 | Windows、PowerShell、Git | `AGENTS.md` |
本项目不需要安装第三方 Python 包。复制到业务项目后，必须把真实语言、框架、版本和支持平台写入本节。
## 阅读入口
- 新人入口：Home。
- 代码入口：[架构与代码地图](Architecture-and-Code-Map.-)。
- 业务边界：[业务规则与术语](Business-Rules-and-Glossary.-)。
- 运行验证：[本地开发与验证](Local-Development-and-Verification.-)。
- 简单维护：[常见修改指南](Common-Changes.-)。
- 错误定位：[故障排查](Troubleshooting)。
## 常用命令 ## 常用命令
@@ -26,6 +40,7 @@
| 用途 | 命令 | 预期结果 | | 用途 | 命令 | 预期结果 |
|---|---|---| |---|---|---|
| 查看工作区 | `git status --short --branch` | 显示分支且没有无关修改 |
| 检查模板结构 | `python scripts/check_harness.py --strict` | 输出“DevHarness 检查通过” | | 检查模板结构 | `python scripts/check_harness.py --strict` | 输出“DevHarness 检查通过” |
| 运行单元测试 | `python -m unittest discover -s tests -v` | 所有测试通过 | | 运行单元测试 | `python -m unittest discover -s tests -v` | 所有测试通过 |
| 导出 Wiki 镜像 | `python scripts/sync_wiki_docs.py` | 映射页面写入 `docs/` | | 导出 Wiki 镜像 | `python scripts/sync_wiki_docs.py` | 映射页面写入 `docs/` |
@@ -42,19 +57,24 @@
| `scripts/` | Harness 检查、Wiki 同步和归档工具 | 产品功能代码 | | `scripts/` | Harness 检查、Wiki 同步和归档工具 | 产品功能代码 |
| `tests/` | Harness 工具自动化测试 | 生产数据 | | `tests/` | Harness 工具自动化测试 | 生产数据 |
## 环境与凭据 ## 环境、配置与凭据
- Wiki 同步配置：仓库根目录 `wiki-docs.json`。 - Wiki 同步配置：仓库根目录 `wiki-docs.json`。
- Gitea 地址可由配置提供，也可通过 `GITEA_URL` 覆盖。 - Gitea 地址可由配置提供，也可通过 `GITEA_URL` 覆盖。
- Gitea Personal Access Token 仅通过 `GITEA_TOKEN` 环境变量提供，不写入仓库。 - Gitea PAT 仅通过 `GITEA_TOKEN` 或 MCP 安全配置提供，不写入仓库。
- Token 至少需要读取仓库权限；创建 Wiki 任务归档时还需要写仓库权限。 - Token 至少需要读取仓库权限；创建或更新 Wiki 时还需要写仓库权限。
- 日志和构建产物：本项目不持久化运行日志；Python 缓存不提交。 - 配置示例：`wiki-docs.json` 只保存非敏感仓库信息。
- 日志：本项目不持久化运行日志，命令行错误是主要诊断信息。
- 测试数据：只使用测试构造的字符串、路径和模拟响应，不使用生产数据。
- 构建产物：Python 缓存和临时文件不提交。
## 项目专用验收要求 ## 项目专用验收要求
- 长期文档必须先更新 Wiki，再导出本地镜像。 - 长期文档必须先更新 Wiki，再导出本地镜像。
- 镜像必须包含来源页面、revision 和同步时间。 - 镜像必须包含来源页面、revision 和同步时间。
- 页面删除、重命名和映射变更必须人工确认。 - 页面删除、重命名和映射变更必须人工确认。
- 新增核心文档时必须更新 Home、显式映射和 Harness 检查。
- 代码入口、命令、配置、业务规则或排错方式变化时必须评估文档影响。
- `python scripts/check_harness.py --strict` 必须通过。 - `python scripts/check_harness.py --strict` 必须通过。
- `python -m unittest discover -s tests -v` 必须通过。 - `python -m unittest discover -s tests -v` 必须通过。
- 未执行或无法覆盖的验证必须记录到工单。 - 未执行或无法覆盖的验证必须记录到工单。