nex_design_system/CLEANUP-GUIDE.md

2.7 KiB
Raw Permalink Blame History

0.1.6 → 0.1.7 清理与迁移指南

本指南用于替换 NEX 规范包,并帮助清理此前 Agent 因过重流程产生的文件。不要把项目自身的业务报告、测试和工具全部误删。

A. NEX 规范包本身

如果项目当前有 standards/nex-design-system/:

  1. 先备份该目录中项目自行添加的文件;
  2. 用 0.1.7 完整替换 NEX 规范包;
  3. 检查项目根 AGENTS.md 中的 NEX 路径;
  4. 更新 nex.config.yaml 的 nex.version 为 0.1.7,保留你已经覆盖的 stack 字段。

不要同时保留多个版本的 NEX 规范目录供 Agent 加载。

B. 可以从 NEX 接入流程中移除的旧规范文件

0.1.7 已不再使用以下测试治理资产。如果它们只是为了 NEX 0.1.6 而加入项目,可以从 NEX 安装目录移除:

  • docs/12-responsive-accessibility-quality.md(旧 E0–E3 / 测试证据 / 质量流程)
  • docs/14-accessibility-platform-matrix.md
  • templates/assistive-technology-test-record.md
  • templates/ui-acceptance-checklist.md(含测试与验收流程的旧版)
  • templates/responsive-breakpoint-registry.md(若只用于断点测试记录;断点设计规则已合并到布局规范)
  • templates/new-project-audit-prompt.md(由新的轻量 project-setup-prompt.md 替代)

注意:这些是旧 NEX 包内的文件,不代表项目自己建立的测试文档都应该删除。

C. 项目根目录的 reports/

不要删除整个 reports/。先分类:

  • 业务报告、用户交付物、运行记录:保留;
  • NEX 阶段过程报告:先合并长期设计决策,再归档或删除;
  • 临时截图、浏览器 trace、重复证据:确认不再引用后可移出 Git 或删除。

如果项目需要保留一份 NEX 设计决策摘要,建议只保留 docs/NEX-DESIGN-DECISIONS.md,不要继续生成每次任务一份的阶段报告。

D. 项目 scripts/ui/

NEX 0.1.7 不要求创建、运行或维护 scripts/ui/。但这不表示可以未经检查直接删除:

  1. 检查 package.json、CI、根 AGENTS.md、文档、pre-commit hooks 和其他脚本是否引用它;
  2. 判断其中哪些脚本确实被项目团队使用;
  3. 仅当确认脚本完全由此前 NEX 治理流程引入、无其他调用者且不再需要时,才可删除;
  4. 仍有项目价值的脚本归项目自身维护,不再归 NEX 管理。

__pycache__/ 是运行缓存,可清理,并应在 .gitignore 中忽略 __pycache__/、*.py[cod]。

E. 不要删除

  • 项目现有 UI 组件、Token、主题和页面代码;
  • 项目自己的 docs/UI规范.md 或其他权威设计规范;
  • 项目业务报告、业务脚本和实际运行所需工具;
  • 用户明确要求保留的历史记录。