chore(repo): initialize reproducible research workspace

This commit is contained in:
Jinotech
2026-09-20 05:17:11 +12:00
commit 1e7cc2a71b
36 changed files with 9169 additions and 0 deletions
+33
View File
@@ -0,0 +1,33 @@
# 项目工作约定
## 强制进度协议
本项目的研究工作以以下两个文件为持续上下文:
- `Document/research-workflow.md`:研究阶段、Gate、交付物与停机条件的唯一工作流基准。
- `Progression.md`:项目当前状态、行动记录、证据、未解决问题与下一步的唯一进度档案。
每次执行任何项目研究行动时,必须遵守:
1. 行动前完整读取 `Document/research-workflow.md``Progression.md`
2. 对照工作流确认当前阶段、允许的动作、预期交付物和适用 Gate。
3. 执行动作,不把计划、既有报告或未经复核的材料记作新结果。
4. 行动后立即编辑 `Progression.md`,至少记录时间、阶段、动作、输入、输出、检查结果、未解决问题和下一步。
5. 只有交付物及检查证据满足工作流要求时,才可把阶段标为 `passed`;证据不足时使用 `in_progress``conditional``blocked``failed`
该协议适用于数据盘点、文献检索、代码或模型开发、统计分析、文档写作、审查和文件管理。只读的临时诊断若直接服务于同一个已登记行动,可合并为一条行动记录,但仍须在行动结束时更新 `Progression.md`
## 强制 Git 协议
本项目使用根目录 Git 仓库保存可复现的研究历史。每次“推进一步”必须形成一个边界清楚、可审计的提交,并遵守以下顺序:
1. 行动开始前,在读取工作流与进度档案的同时检查 `git status --short`,识别并保护用户已有或无关改动。
2. 只修改当前行动范围内的文件;不得擅自覆盖、撤销或混入用户的其他改动。
3. 完成行动和验证后,先更新 `Progression.md`,写明输出、检查结果、提交/推送状态与下一步。
4. 检查 `git diff` 和待提交文件清单,只暂存本行动相关文件;严禁提交凭据、原始/受限数据、解释器、虚拟环境、R library、安装器、缓存、模型权重或可重建的大型二进制。
5. 为每个完成的推进动作创建一个非交互式 Git 提交;提交信息应简洁说明阶段与动作,不得把多个无关行动压成一个提交。
6. 若已配置远程与上游分支,提交成功后必须立即执行 `git push`,并把结果记录到 `Progression.md`
7. 若没有远程、缺少凭据或推送失败,不得声称已推送;在 `Progression.md` 标为 `push_pending``push_failed` 并记录原因。远程一旦配置,开始下一项研究行动前应先推送所有待推提交。
8. 删除、改写历史、强制推送、变基已共享提交或变更远程地址仍需用户明确授权;本协议不自动授权破坏性 Git 操作。
根目录 `.gitignore` 是版本化边界的一部分。新增大文件类型、数据目录、模型缓存或生成物时,必须先判断是否应忽略;不得依赖事后从历史中清除敏感或超大文件。