日志记录规范

GitCode 相关 skill 的日志命名和记录要求。


日志文件命名格式

logs/{task_type}_{YYYYMMDD}_{HHMMSS}.log

各 skill 的 task_type

Skill task_type 示例文件名
code-review code-review logs/code-review_20260319_143000.log
gitcode-pr-handler gitcode-pr-handler logs/gitcode-pr-handler_20260319_143000.log
gitcode-issue-gen gitcode-issue-gen logs/gitcode-issue-gen_20260319_143000.log
pr-to-design-doc pr-to-design-doc logs/pr-to-design-doc_20260319_143000.log
pr-compile pr-compile logs/pr-compile_20260319_143000.log
gitcode-issue-handler gitcode-issue-handler logs/gitcode-issue-handler_20260319_143000.log
pr-create pr-create logs/pr-create_20260319_143000.log

日志内容要求

日志必须包含以下内容,尽可能详细记录:

1. 基本信息

  • 任务开始/结束时间
  • 任务目标/用户原始请求

2. 与模型的交互过程

  • 用户发送的每条消息
  • 模型回复的完整内容(包括思考过程、决策依据)
  • 交互的时间戳

3. 工具调用记录

  • 调用的工具名称
  • 传递的完整参数
  • 工具返回的完整结果
  • 调用时间戳

4. 错误处理过程

  • 遇到的错误信息
  • 错误分析过程
  • 解决方案和尝试步骤
  • 最终解决结果

5. 使用的 Skill

  • Skill 名称和描述
  • Skill 文件路径
  • Skill 提供的功能说明

6. API 调用记录(如有)

  • API 端点
  • 请求参数
  • 响应结果
  • 状态码

7. 最终结果

  • 任务完成状态
  • 产出物(文件、链接等)
  • 问题总结
  • 后续建议

日志示例结构

================================================================================
[时间戳] 用户请求: xxx
================================================================================

================================================================================
[时间戳] 模型思考: xxx
================================================================================

================================================================================
[时间戳] 工具调用: Read
参数: {"file_path": "xxx"}
返回: "文件内容..."
================================================================================

================================================================================
[时间戳] 错误发生: xxx
错误分析: xxx
解决方案: xxx
================================================================================

注意事项

  • 日志保存在项目根目录的 logs/ 目录下
  • 各 skill 可以在基础规范之上增加专用的日志格式(如 code-review 的检视意见日志格式)
  • 完整日志规范见项目根目录 CLAUDE.md