gewuyou/GFramework
1
0
Fork 0
mirror of https://github.com/GeWuYou/GFramework.git synced 2026-05-07 00:39:00 +08:00
Code Issues Packages Projects Releases Wiki Activity
GFramework/ai-plan/README.md
gewuyou 6ab32032bc refactor(repo): 重构ai-plan目录语义 
- 重命名 local-plan 为 ai-plan，并收口 public 与 private 的目录语义
- 更新 AGENTS、README 与 boot skill 的恢复文档路径和安全约束
- 迁移共享 tracking 与 trace 文件到 ai-plan/public，并补充治理说明文档
2026-04-19 03:18:46 +08:00

1.5 KiB
Raw Blame History

AI Plan

ai-plan/ stores AI task recovery artifacts for this repository, but not every file under it has the same sharing rules.

Directory Semantics

  • public/todos/
    • Repository-safe recovery documents.
    • Use these for durable task state that another contributor or worktree may need to resume safely.
    • These files may be committed.
  • public/traces/
    • Repository-safe execution traces that record decisions, validation milestones, and the immediate next step.
    • These files may be committed.
  • private/
    • Worktree-private recovery space.
    • Use this for temporary notes, local scratch recovery points, or state that only matters in the current worktree.
    • Keep this directory untracked.

Content Rules

  • Never write secrets, tokens, credentials, private keys, hostnames, IP addresses, proprietary URLs, or other sensitive data.
  • Never write absolute file-system paths, home-directory paths, or machine usernames.
  • Use repository-relative paths, branch names, PR numbers, recovery-point IDs, and stable document identifiers instead.
  • Keep committed public/** content concise, handoff-safe, and understandable without machine-local context.

Naming

  • Shared recovery documents should describe the task, for example:
    • public/todos/cqrs-rewrite-migration-tracking.md
    • public/traces/cqrs-rewrite-migration-trace.md
  • Worktree-private files should live under a folder named for the current branch or worktree, for example:
    • private/feat-cqrs-optimization/
    • private/gframework-cqrs/