Back to Details

agents-update

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

AGENTS.md Update

AGENTS.md 更新

Keep AGENTS.md under 140 LOC. Move detailed content to 
agent_docs/
, don't just delete.
保持AGENTS.md的行数不超过140 LOC。将详细内容迁移至
agent_docs/
目录，而非直接删除。

Core Rule

核心规则

AGENTS.md ≤ 140 LOC: Quick reference + links only agent_docs/: Complete instructions with examples
AGENTS.md ≤ 140 LOC：仅保留快速参考内容与链接 agent_docs/：包含示例的完整指令文档

Section Mapping

章节映射

AGENTS.md SectionTarget agent_docs/ FileStatus
Quick Reference
scripts/
✓ commands
Change Workflow
agent_docs/code_conventions.md
✓
Core Invariants
agent_docs/code_conventions.md
✓
Common Pitfalls
agent_docs/code_conventions.md
✓
Tool Selection
agent_docs/code_conventions.md
✓
Atomic Change Rules
agent_docs/git_workflow.md
✓
Required Checks
agent_docs/building_the_project.md
✓
Git Workflow
agent_docs/git_workflow.md
✓
Feature Flags
agent_docs/building_the_project.md
✓
Security
agent_docs/code_conventions.md
✓
Environment Variables
agent_docs/code_conventions.md
✓
Performance Targets
agent_docs/code_conventions.md
✓
Disk Space
agent_docs/building_the_project.md
✓
Planning & Decisions
plans/ROADMAPS/ROADMAP_ACTIVE.md
✓
AGENTS.md 章节目标 agent_docs/ 文件状态
快速参考
scripts/
✓ 命令
变更工作流
agent_docs/code_conventions.md
✓
核心不变量
agent_docs/code_conventions.md
✓
常见陷阱
agent_docs/code_conventions.md
✓
工具选择
agent_docs/code_conventions.md
✓
原子变更规则
agent_docs/git_workflow.md
✓
必填检查项
agent_docs/building_the_project.md
✓
Git 工作流
agent_docs/git_workflow.md
✓
功能标志
agent_docs/building_the_project.md
✓
安全规范
agent_docs/code_conventions.md
✓
环境变量
agent_docs/code_conventions.md
✓
性能目标
agent_docs/code_conventions.md
✓
磁盘空间要求
agent_docs/building_the_project.md
✓
规划与决策
plans/ROADMAPS/ROADMAP_ACTIVE.md
✓

Workflow

工作流

1. Read Current State

1. 查看当前状态

  • Read AGENTS.md and relevant agent_docs/ files
  • Check Section Mapping table
  • For complex changes, use 
    goap-agent
    skill to decompose
  • 阅读AGENTS.md及相关agent_docs/文件
  • 核对章节映射表
  • 对于复杂变更，使用
    goap-agent
    技能进行分解

2. Move Content (Not Delete!)

2. 迁移内容（请勿删除！）

  • Find target location from mapping
  • Add full content with examples
  • Ensure standalone usability
  • 根据映射表找到目标位置
  • 添加包含示例的完整内容
  • 确保内容可独立使用

3. Update AGENTS.md

3. 更新AGENTS.md

  • Replace with brief summary + reference link
  • Keep under 140 LOC
  • 替换为简短概述+参考链接
  • 保持行数不超过140 LOC

4. Validate

4. 验证

bash
wc -l AGENTS.md  # Must be ≤140
ls agent_docs/   # Verify all files exist
bash
wc -l AGENTS.md  # Must be ≤140
ls agent_docs/   # Verify all files exist

Quality Checks

质量检查项

  • wc -l AGENTS.md
    ≤ 140
  • All sections mapped to agent_docs/
  • agent_docs/ files have code examples
  • Can follow agent_docs/ instructions independently
  • Cross-References table lists all agent_docs/
  • wc -l AGENTS.md
    的结果 ≤140
  • 所有章节均已映射至agent_docs/
  • agent_docs/文件包含代码示例
  • 可独立遵循agent_docs/中的指令完成操作
  • 交叉引用表列出所有agent_docs/内容

Best Practices

最佳实践

  • Follow agentskills.io spec
  • Keep SKILL.md under 250 LOC
  • agent_docs/ files must be usable as standalone instructions
See references/AGENTS_UPDATE_REFERENCE.md for detailed workflow.
  • 遵循agentskills.io 规范
  • 保持SKILL.md的行数不超过250 LOC
  • agent_docs/文件需可作为独立使用的指令文档
详细工作流请参考references/AGENTS_UPDATE_REFERENCE.md。