changelog-guide

變更日誌指南

語言: English | 繁體中文

版本: 1.0.0 最後更新: 2025-12-30 適用範圍: Claude Code Skills

目的

此技能幫助依照 Keep a Changelog 格式撰寫與維護 CHANGELOG.md 檔案，確保清楚地向使用者傳達變更內容。

快速參考

檔案結構

# 變更日誌

本專案的所有重要變更都將記錄在此檔案中。

格式基於 [Keep a Changelog](https://keepachangelog.com/)，
並遵循[語義化版本](https://semver.org/)。

## [未發布]

## [1.2.0] - 2025-12-15

### 新增
- 功能描述

### 變更
- 變更描述

### 修復
- 錯誤修復描述

[未發布]: https://github.com/user/repo/compare/v1.2.0...HEAD
[1.2.0]: https://github.com/user/repo/compare/v1.1.0...v1.2.0

變更類別

Commit Type 對應 Changelog

條目格式

標準格式

- [動作動詞] [變更內容] ([參考])

範例

### 新增
- 新增可自訂小工具的使用者儀表板 (#123)
- 新增 PostgreSQL 15 支援 (PR #456)

### 變更
- **BREAKING**: API 回應格式從 XML 改為 JSON (#789)
- 更新最低 Node.js 版本至 18.0 (#101)

### 修復
- 修復處理大型檔案時的記憶體洩漏 (#112)
- 修復報表中日期格式錯誤 (#134)

### 安全
- 修復搜尋端點的 SQL 注入漏洞 (高風險, CVE-2025-12345)

詳細指南

完整標準請參考：

• 變更日誌標準

AI 優化格式（節省 Token）

AI 助手可使用 YAML 格式檔案以減少 Token 使用量：

• 基礎標準：ai/standards/changelog.ai.yaml

撰寫指南

為使用者撰寫，而非開發者

破壞性變更

務必清楚標記破壞性變更：

### 變更
- **BREAKING**: 移除已棄用的 `getUserById()` 方法，請改用 `getUser()`
- **BREAKING**: 設定檔格式從 YAML 改為 TOML

### 移除
- **BREAKING**: 移除 Node.js 14 支援

安全公告

包含嚴重程度和 CVE（如有）：

### 安全
- 修復搜尋端點的 SQL 注入漏洞 (高風險, CVE-2025-12345)
- 修復留言區的 XSS 漏洞 (中風險)
- 更新 `lodash` 相依套件以修補原型污染 (低風險)

版本標題格式

## [版本] - YYYY-MM-DD

範例：

## [2.0.0] - 2025-12-15
## [1.5.0-beta.1] - 2025-12-01
## [未發布]

排除規則

以下不應記錄在 CHANGELOG 中：

常見錯誤

設定偵測

此技能支援專案特定設定。

偵測順序

1. 檢查現有 CHANGELOG.md 格式
2. 檢查 CONTRIBUTING.md 中的變更日誌指南
3. 若無找到，預設使用 Keep a Changelog 格式

首次設定

若 CHANGELOG.md 不存在：

1. 建議使用標準範本建立
2. 建議在 CONTRIBUTING.md 中記錄指南：

## 變更日誌指南

- 為所有使用者可見的變更更新 CHANGELOG.md
- 開發期間將條目加入 [未發布] 區段
- 使用標準類別：新增、變更、棄用、移除、修復、安全
- 引用 issue/PR 編號：`修復錯誤 (#123)`
- 使用 **BREAKING** 前綴標記破壞性變更

相關標準

• 變更日誌標準
• 版本控制標準
• 提交訊息指南
• 發布標準技能

版本歷史

授權

此技能採用 CC BY 4.0 授權。

來源: universal-dev-standards