Skip to content

Buglog 规范

文件格式

每个 bug 一个独立文件,命名:YYYY-MM-DD-简短英文描述.md(中文标题描述)。


必填字段(文件首部)

markdown
# <标题:简短描述 bug 现象>

> **状态**: 🟢 已修复 | 🔴 未修复 | 🟡 搁置 | ⚪ 已确认不修

**日期**: YYYY-MM-DD
**严重程度**: 🔴 P1 | 🟠 P2 | 🟡 P3 | 🟢 P4
**影响范围**: `frontend/src/xxx/xxx.ts`(具体文件路径)
**发现方式**: 用户反馈 | 开发发现 | 测试发现 | CI 失败
**修复提交**: `<commit-sha>`(可选,已修复时填)

正文模板

markdown
---

## 问题描述

简短描述用户可见的症状。

## 复现步骤(可选)

1. 操作 A
2. 操作 B
3. 观察到...

## 根因分析

从代码层面分析为什么会出现这个问题。

## 修复方案

描述修复思路,引用提交号。

## 教训(可选)

1-3 条经验总结,供后续开发参考。

状态标签含义

标签含义操作要求
🟢 已修复已有提交修复,可关闭更新标题加 [FIXED] 前缀(可选)
🔴 未修复问题仍存在,待修复保持原样,修复后改为 🟢
🟡 搁置问题存在但优先级低,暂缓注明搁置原因
⚪ 已确认不修经评估决定不修复注明不修理由(如:Wails 限制、Babylon 上游限制)

状态流转

🔴 未修复 ──→ 🟢 已修复(有提交)

      └──→ 🟡 搁置(主动暂缓)
      └──→ ⚪ 已确认不修(经评估放弃)

归档

状态为 🟢 已修复 超过 1 个月的 bug,可移动到 docs/buglog/archived/ 目录,不影响查找(Git 历史可查)。