Back to Details

research-project-maintenance

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Research Project Maintenance

研究项目维护

Keep the repository usable as both software project and scholarly record.
确保仓库既能作为软件项目使用，也能作为学术记录留存。

Read First

必读文档

  • references/repository-contract.md
  • references/output-contracts.md
  • references/external-skill-recommendations.md
  • references/repository-contract.md
  • references/output-contracts.md
  • references/external-skill-recommendations.md

Maintenance Tasks

维护任务

  • create missing research folders
  • update 
    AGENTS.md
  • update README layout
  • update 
    configs/agent-stack.yaml
  • update 
    configs/capabilities.yaml
  • update 
    docs/agent/
    workflow and capability records
  • update 
    docs/agent/capability-profile.md
  • update 
    docs/agent/mcp-setup.md
  • update wiki templates
  • add structural tests
  • separate raw sources from derived outputs
  • move notebook logic into 
    src/
  • add reproducibility commands
  • keep maintenance changes scoped to the repository contract the user selected
  • 创建缺失的研究文件夹
  • 更新
    AGENTS.md
    文件
  • 更新README布局
  • 更新
    configs/agent-stack.yaml
    文件
  • 更新
    configs/capabilities.yaml
    文件
  • 更新
    docs/agent/
    下的工作流和能力记录
  • 更新
    docs/agent/capability-profile.md
    文件
  • 更新
    docs/agent/mcp-setup.md
    文件
  • 更新wiki模板
  • 添加结构测试
  • 分离原始源码与派生输出文件
  • 将笔记本逻辑迁移至
    src/
    目录
  • 添加可复现性命令
  • 确保维护变更符合用户选定的仓库契约

Structure Check

结构检查

Validate at least:
  • source and SOTA directories exist
  • wiki index/log exist
  • data policy is documented
  • output directories are separated by trust level
  • experiments have registry and record templates
  • MCP and skill recommendations are documented
  • agent onboarding and capability profile are documented when the repo supports them
  • generated or large files are ignored appropriately
至少验证以下内容：
  • 源码和SOTA目录已存在
  • wiki索引/日志已存在
  • 数据政策已记录在案
  • 输出目录按信任级别区分
  • 实验具备注册表和记录模板
  • 已记录MCP和skill推荐内容
  • 当仓库支持Agent时，已记录Agent入职流程和能力配置文件
  • 生成文件或大文件已被正确忽略

Do Not

禁止操作

  • Flatten the repo into notebooks.
  • Hide important workflow rules inside chat history.
  • Put secrets, raw sensitive datasets, or model weights in git.
  • Move user data without preserving provenance.
  • 不要将仓库扁平化到笔记本文件中。
  • 不要将重要工作流规则隐藏在聊天记录里。
  • 不要将密钥、原始敏感数据集或模型权重存入git。
  • 不要在不保留溯源信息的情况下移动用户数据。