變更日誌範本(CHANGELOG Template) 參照標準:Keep a Changelog 1.1.0 / Semantic Versioning 2.0.0
文件用途:記錄專案每個版本的顯著變更,讓使用者與開發者了解版本間的差異
適用階段:專案全生命週期(每次發版皆需更新)
📋 章節目錄 文件資訊 格式規範 變更類別定義 版本編號規則 撰寫規範 CHANGELOG 完整範本 自動化產生 附錄 1. 文件資訊 📝 範本 項目 內容 文件名稱 CHANGELOG.md 位置 專案根目錄 格式 Markdown(Keep a Changelog 格式) 維護者 {Release Manager / 開發團隊} 更新時機 每次版本發布(Release) 📖 使用說明 CHANGELOG.md 置於專案根目錄,與 README.md 並列 每次 Release 前更新,不是每個 Commit 都記錄 記錄「對使用者有意義的變更」,非所有技術細節 💡 範例 CHANGELOG.md 通常長這樣的開頭:
# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). 2. 格式規範 📝 範本 # Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] ### Added - {新功能描述} ## [{版本號}] - {YYYY-MM-DD} ### Added - {新增功能} ### Changed - {變更項目} ### Deprecated - {即將移除的功能} ### Removed - {已移除的功能} ### Fixed - {修復的問題} ### Security - {安全性修復} [Unreleased]: {repo-url}/compare/v{版本}...HEAD [{版本號}]: {repo-url}/compare/v{前版本}...v{版本} 📖 使用說明 [Unreleased] 區塊永遠在最上方,收集尚未發布的變更 發版時將 [Unreleased] 內容移至新版本區塊 版本由新到舊排列(最新在最上面) 底部的連結區塊提供版本間的 diff 比較連結 💡 範例 見第 6 節完整範本。
...