documenting-decisions
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseDocumenting Decisions
决策记录
Checkpoint tags
检查点标签
| Tag | When to mark |
|---|---|
| New abstractions, deps, data models, component boundaries — anything that shapes long-term structure. |
| You resolved an ambiguity in the task by choosing an interpretation. |
| Changed a public API, config schema, CLI flag, env var, or wire format. |
| Touched auth, crypto, permissions, network exposure, or input validation. |
| Created a migration, data deletion, deployment trigger, or external side effect. |
| No existing repo pattern to follow — you interpolated from training data. |
Do not mark routine changes (pattern-following, boilerplate, refactoring).
| Tag | 标记时机 |
|---|---|
| 新的抽象概念、依赖项、数据模型、组件边界——任何影响长期架构的内容。 |
| 通过选择一种解释来解决任务中的歧义。 |
| 修改了公共API、配置 schema、CLI 标志、环境变量或 wire format。 |
| 涉及身份验证、加密、权限、网络暴露或输入验证相关内容。 |
| 创建了迁移、数据删除、部署触发器或外部副作用操作。 |
| 没有现有仓库模式可遵循——从训练数据中推导实现。 |
请勿标记常规变更(遵循模式、样板代码、重构)。
Format
格式
See this skill's and (if needed) .
references/decision-markers.mdmarker-examples.md请查看本skill的目录下的,必要时可查看。
references/decision-markers.mdmarker-examples.mdAfter task completion
任务完成后
Generate decision log from markers in changed files and add to PR description:
undefined从变更文件中的标记生成决策日志,并添加到PR描述中:
undefinedDecisions requiring review
Decisions requiring review
- TAG — explanation
file:line
- TAG — explanation
file:line
Routine (skip review)
Routine (skip review)
[One-line summary]
undefined[One-line summary]
undefinedDiff classification mode
差异分类模式
When user requests review of diff, classify each hunk as one of the six tags or . Present as with line ranges.
ROUTINEFile: path — TAG当用户请求审查代码差异时,将每个代码块归类为六个标签之一或。以格式呈现,并附带行号范围。
ROUTINEFile: path — TAGReference files
参考文件
- — CI scripts for automated checkpoint detection (repo setup, not runtime).
references/canary-signals.md - — example markers in multiple languages.
references/marker-examples.md - other files in references are only relevant if explicitly mentioned in AGENTS.md or requested by the user.
- — 用于自动检查点检测的CI脚本(仓库配置,非运行时)。
references/canary-signals.md - — 多语言示例标记。
references/marker-examples.md - references目录中的其他文件仅在AGENTS.md中明确提及或用户请求时才相关。