建立文档联动更新机制
通过以下方法保持AGENTS.md与项目演进同步:
- 变更关联:在项目Changelog中添加AGENTS.md更新要求,当出现以下变更时强制更新:
- 开发工具链升级(如从webpack改为vite)
- 测试框架调整(如Jest改为Vitest)
- CI/CD流程修改
- 版本控制:将AGENTS.md纳入代码审查(PR Check List):
- 添加审查项:”是否需同步更新AGENTS.md”
- 配置保护分支规则,防止未经更新的AGENTS.md合并
- 自动校验:编写脚本检查命令有效性:
- 定期运行AGENTS.md中的测试命令验证可用性
- 集成到CI流程作为门禁检查
推荐设置文档负责人(如Tech Lead)每月审查AGENTS.md有效性,对过期指令添加deprecated标注并及时替换。
本答案来源于文章《AGENTS.md:为AI编程智能体提供指导的开放格式文件》