0.8
This commit is contained in:
@@ -1,43 +0,0 @@
|
||||
# 已有研究项目升级提醒
|
||||
|
||||
**v0.7 起建议使用 [UPGRADE_v0.7.md](UPGRADE_v0.7.md) 所述自动迁移工具。** 以下仅保留旧版手动迁移说明供历史参考。
|
||||
|
||||
# 从 Code4History v0.2 更新到 v0.3
|
||||
|
||||
**新建项目**：直接解压完整 v0.3 ZIP 即可；不要把 v0.1/v0.2 的旧 Skill 目录混入新项目。
|
||||
|
||||
**已有研究项目**：先备份本地 `topic.md`、`STATE.md`、`00_governance/`、`01_sources/`—`09_outputs/`、尚未提交的其他变更（如 `git status`）；勿用空白模板覆盖真实研究资料。然后引入新的框架说明、测试和工具，并完成以下两项旧入口清理：
|
||||
|
||||
- 旧 Skill：`.agents/skills/history-writing-workflow/` → 用新的 `.agents/skills/history-writing-workflow-c4h/` **替换**。不要让旧新两种 Skill 同时存在；新技能的 `name` 已更改。
|
||||
- 删除退休入口 `agent.md`（若存在 `AGENT.md` 也删除）。**保留 `AGENTS.md`**，它是 Codex 默认文件。
|
||||
|
||||
PowerShell（在仓库根目录执行；确认旧目录没有用户自己额外写入的内容再运行）：
|
||||
|
||||
```powershell
|
||||
Remove-Item -LiteralPath '.agents/skills/history-writing-workflow' -Recurse -Force -ErrorAction SilentlyContinue
|
||||
Remove-Item -LiteralPath 'agent.md' -Force -ErrorAction SilentlyContinue
|
||||
Remove-Item -LiteralPath 'AGENT.md' -Force -ErrorAction SilentlyContinue
|
||||
```
|
||||
|
||||
Linux/macOS：
|
||||
|
||||
```bash
|
||||
rm -rf -- .agents/skills/history-writing-workflow
|
||||
rm -f -- agent.md AGENT.md
|
||||
```
|
||||
|
||||
将 v0.3 模板的 `USERINFO.md` **空文件**加入项目；如果用户已有自己的 `USERINFO.md`，不要覆盖或清空。将旧版 Q18 保留原答，在 `topic.md` 末尾添加 Q19/Q20（空白即原默认95分、50字），不要改动其他已确认问题。
|
||||
|
||||
然后检查：
|
||||
|
||||
```bash
|
||||
python tools/doctor.py
|
||||
python tools/validate.py
|
||||
python -m unittest discover -s tests -v
|
||||
```
|
||||
|
||||
如果旧项目包含自定义 Skill，比较后再迁移相应功能，不能简单认为新框架覆盖后不会有冲突。本文件是迁移操作建议，不自动改变任何远程 Git 仓库。
|
||||
|
||||
## v0.8 双向交接区
|
||||
|
||||
升级操作使用 v0.8 `tools/migrate.py` 与 `migration_baselines.json`。`upload` 等待处理的附件（即使被 .gitignore 排除）、`todo` 尚待用户回答的事项、`requests` 尚未完成的请求、`handoff/latest.md` 均属于**研究内容**，不是可被新版空白模板清理的框架文件。详细参见 `UPGRADE_v0.8.md`。
|
||||
@@ -1,24 +0,0 @@
|
||||
# 从 Code4History v0.3 升级到 v0.4
|
||||
|
||||
## 升级原则
|
||||
|
||||
- v0.4 调整的是**研究解释与写作流程**，不是研究事实、现有假说或具体选题。
|
||||
- 补丁包**不包含**已有研究资料、`topic.md`、`USERINFO.md`、`STATE.md`、参考文献库及已建卡片，因此不会主动覆盖它们。
|
||||
- 补丁会覆盖 `AGENTS.md`、`code4history.md`、主 Skill 的若干说明与相关模板。若已手动改写这些框架文件，请先建立 Git 提交或备份，并逐项合并改动。
|
||||
|
||||
## 操作
|
||||
|
||||
1. 在你自己的 Code4History 仓库中先提交或备份当前变更。
|
||||
2. 解压 **code4history-v0.4-framework-patch.zip** 到包含 `code4history/` 文件夹的上一级目录；确认合并覆盖框架文件。亦可手工复制本补丁中需要的文件。
|
||||
3. 运行 `python tools/validate.py` 与 `python -m unittest discover -s tests -v`。
|
||||
4. 在新的 Codex 会话中要求其读取根 `AGENTS.md` 与 `INTERPRETATION.md`，按更新后的主 Skill 继续现有课题。
|
||||
5. 若旧会话已陷入防御循环，可将 `QUICK_FIX.md` 中的提示词直接发给 Codex，无需等待重新索引。
|
||||
|
||||
## 哪些内容没有变化
|
||||
|
||||
- `USERINFO.md` 保持用户自填优先级，补丁不写入任何内容。
|
||||
- `topic.md` 仍使用 Q1—Q20，没有加入新的复杂配置。
|
||||
- 三个 Skill 的名称、卡片编号、目录结构、工具命令保持兼容。
|
||||
- 不降低原始文献、逐字引文、关键事实与数字的校验要求；仅取消不必要的**解释和写作阻断**。
|
||||
|
||||
**注意：**本次测试确认结构和工具功能，不能保证 Codex 在任何上下文下都不会再次保守化。如果现有会话积累了大量旧的反复审查记录，建议新开 Codex 会话并只读取持久化研究文件。
|
||||
@@ -1,14 +0,0 @@
|
||||
# Code4History v0.5 升级说明：论证增量与去空话
|
||||
|
||||
本次更新针对“把原始史料同义复述成冗长、空洞的学术结论”的问题，目标是**提升信息密度，而不是设置新的形式审核闸门**。
|
||||
|
||||
## 升级方式
|
||||
|
||||
1. 为现有研究仓库的变更做 Git 提交或备份。
|
||||
2. 将 `code4history-v0.5-framework-patch.zip` 解压并覆盖同名**框架文件**。压缩包内顶层为 `code4history/`，注意解压层级。
|
||||
3. `topic.md`、`USERINFO.md`、`STATE.md`、已有文献、证据、论点与论文内容**不会被补丁覆盖**。
|
||||
4. 新会话要求 Codex 读取 `AGENTS.md`、`INTERPRETATION.md` 和新增的 `ARGUMENT_DENSITY.md`，继续研究，不需要重新启动选题流程。
|
||||
5. 可直接复制 `QUICK_FIX.md` 新增的“消除学术废话”提示词，对既有论文做一次删冗余编辑。
|
||||
6. 可选运行 `python tools/validate.py` 与 `python -m unittest discover -s tests -v`。
|
||||
|
||||
新增协议不要求每句单独评分、也不强制生成新的学术发现。它允许保留有用的简单事实，禁止把重复事实写成“意义”，并鼓励删除与总论题无关的材料。事实、引文和重要反证的真实性要求保持不变。
|
||||
@@ -1,19 +0,0 @@
|
||||
# Code4History v0.6 升级说明：跨证据综合与论文逻辑
|
||||
|
||||
此次更新针对“每个 EV 独立产出一个无价值结论、段落缺逻辑衔接、关键历史原文被过度转述”三个互相关联的问题。
|
||||
|
||||
## 对已有研究仓库的安全升级
|
||||
|
||||
1. 先 Git 提交或备份当前工作副本。
|
||||
2. 将 `code4history-v0.6-framework-patch.zip` 解压并覆盖同名框架文件（ZIP 顶层目录为 `code4history/`）。
|
||||
3. **升级包不包含** `topic.md`、`USERINFO.md`、`STATE.md`、史料 PDF、EV/Q/H/C 卡、已有 SYN 卡、论文正文及现有研究日志；不会覆盖你的研究内容。
|
||||
4. 新会话让 Codex 阅读 `AGENTS.md`、`SYNTHESIS_AND_PROSE.md` 和原有 `ARGUMENT_DENSITY.md`，再继续当前研究；不必重启选题。
|
||||
5. 运行 `python tools/doctor.py`、`python tools/validate.py`、`python -m unittest discover -s tests -v` 进行结构验证。工具不能替代引文逐字核对。
|
||||
6. 现有草稿重写可用根 `QUICK_FIX.md` 中的跨证据改写提示词。优先先选一个小节测试效果。
|
||||
|
||||
## 兼容性
|
||||
|
||||
- 新增 `SYN-0001` 类型，命令 `python tools/new_item.py --kind synthesis --slug ...`；关联字段 `synthesis_ids: []` 可选。
|
||||
- `10_templates/section-plan.md` 是按需复制的写作设计表，不是填写门槛。
|
||||
- 已有 EV、C、论文章节无须迁移或改名；旧引文要求、禁止编造材料等约束仍在。
|
||||
- **不强制证据数量、直接引文数量、每段连接词数量**，也不进行无限评分审查。
|
||||
@@ -1,67 +0,0 @@
|
||||
# Code4History v0.7：跨版本迁移工具
|
||||
|
||||
从 v0.1–v0.6 迁移至 v0.7 时，不再需要手工判断哪些文件属于框架、哪些属于研究资料。
|
||||
|
||||
## 一键升级（建议：创建新目录）
|
||||
|
||||
先下载最新的完整模板 ZIP（例如 `code4history-v0.7.zip`），**无需先删除或覆盖旧目录**。
|
||||
|
||||
在 Windows PowerShell 中（Python 3.10+）：
|
||||
|
||||
```powershell
|
||||
python .\code4history\tools\migrate.py upgrade --source "D:\History\old-project" --template "D:\Downloads\code4history-v0.7.zip" --target "D:\History\new-project"
|
||||
```
|
||||
|
||||
此处 `migrate.py` 是从新版模板提取的脚本；旧版 v0.1–v0.6 没有这个工具。`--target` 必须是**尚不存在的**新目录，不能与旧目录相同或位于旧目录内。成功后在新项目运行：
|
||||
|
||||
```powershell
|
||||
python tools/doctor.py
|
||||
python tools/validate.py
|
||||
python -m unittest discover -s tests -v
|
||||
```
|
||||
|
||||
原项目、原 PDF、原论文与原 Git 历史均保持原状。迁移并不会自动复制 `.git` 历史；如需延续原仓库 Git 分支与提交，需另行迁移 Git 仓库或选取新目录后重新绑定远端。
|
||||
|
||||
## 分两步导出、恢复（可控制和预览）
|
||||
|
||||
从旧项目导出：
|
||||
|
||||
```bash
|
||||
python /path/to/new/tools/migrate.py export --source /path/to/old-project --out /path/to/private-backup.c4h.zip
|
||||
```
|
||||
|
||||
把新模板 ZIP 解压为一个**独立的新项目目录**，然后预览与恢复：
|
||||
|
||||
```bash
|
||||
python /path/to/new/tools/migrate.py restore --bundle /path/to/private-backup.c4h.zip --target /path/to/new-project --dry-run
|
||||
python /path/to/new/tools/migrate.py restore --bundle /path/to/private-backup.c4h.zip --target /path/to/new-project
|
||||
```
|
||||
|
||||
可以在 `export` 加 `--dry-run` 先查看分类统计。两个命令都有 `--help`。
|
||||
|
||||
## 会保留什么？
|
||||
|
||||
- 已填写的 `topic.md`、`USERINFO.md`、`STATE.md`；研究决策、检查点、日志、参考文献数据库。
|
||||
- 史料原始文件（包括未被 Git 跟踪的 PDF）、转录、史料卡、证据卡、问题卡、假说卡、概念和背景笔记、学术史、综合与论点。
|
||||
- 论文正文、章节排列、大纲、审稿记录和研究产出；框架目录之外的普通自建研究文件。
|
||||
- 已改写的**框架规则文件、Skills、脚本、模板、目录 readme** 会**另外归档**，不会直接覆盖新版本的规则。可在恢复后自行择取需要保留的自定义规则。
|
||||
|
||||
精确匹配 v0.1–v0.7 官方模板内容的空白文件不会重复导出。旧框架源代码、旧 Skill 不会覆盖新版。
|
||||
|
||||
## 冲突处理与安全性
|
||||
|
||||
1. 如果目标位置不存在：恢复至原路径。
|
||||
2. 如果目标位置仍是官方空白研究模板：填入旧研究内容（例如 `topic.md` 和 `STATE.md`）。
|
||||
3. 如果目标位置已有不同的用户内容：**不覆盖**，将迁入内容放在 `.code4history-migration/conflicts/<时间>/incoming/`。
|
||||
4. 如果是修改过的旧框架规则或附加的 Skill/脚本：放在 `.code4history-migration/conflicts/<时间>/framework_customizations/`，需人工审阅后再使用。
|
||||
5. 所有导入文件在写入之前经过 SHA-256 完整性校验；禁止路径穿越和软链接提权；写入用临时文件后原子替换。
|
||||
|
||||
恢复记录保存于 `.code4history-migration/latest-report.json`。如果出现冲突，**应当解决这些冲突之后再进行下次升级**。这不是自动语义合并工具，不会替你合并同一研究卡的两份不同修改。
|
||||
|
||||
## 不自动导出的内容
|
||||
|
||||
- Git 历史 (`.git/`)、Python 虚拟环境、编辑器缓存和临时编译文件。
|
||||
- `.env`、密钥、证书与常见凭证文件，以免误打包机密；如它们确实属于你的研究资料，请另行安全备份。
|
||||
- 软链接（不会追踪链接目标）。
|
||||
|
||||
**迁移包可能包含未公开手稿、版权受限的 PDF 和个人研究笔记。应当在本地保管，不要上传到公开仓库。**
|
||||
@@ -1,9 +0,0 @@
|
||||
# v0.8 迁移说明：人机交接区
|
||||
|
||||
v0.8 新增 `/upload`、`/requests`、`/todo`、`/handoff`，以及 `01_sources/provenance` 和 `tools/interaction.py`。
|
||||
|
||||
**不在旧研究仓库上直接解压新模板。** 使用 `python tools/migrate.py upgrade --source OLD --template code4history-v0.8.zip --target NEW`，或 export/restore 两阶段迁移。先使用 `--dry-run` 查看将迁移的研究文件与框架定制。
|
||||
|
||||
新目录既保留旧 `topic.md`、`USERINFO.md`、`STATE.md`、史料、笔记、论文，也保留已存在的旧用户自定义交接文件（如 `/todo/TODO-*.md`、`/requests/*.md`、`/upload/*.pdf`、`/upload/*.source.md`、`/handoff/latest.md`）。不让新模板的空白内容覆盖已填交接事项。自行改过的框架入口和 Skill 仅供人工比对，不自动覆盖 v0.8。
|
||||
|
||||
迁移完成后在新目录执行 `python tools/interaction.py scan` 与 `python tools/validate.py`，确认收件箱与待办；处理遗留上传时不得因为迁移即视为已归档。
|
||||
Reference in New Issue
Block a user