Skip to main content

Command Palette

Search for a command to run...

Conventional Commits - 約定式提交

Updated
1 min readView as Markdown
Conventional Commits - 約定式提交

參考資料:

英文 - https://www.conventionalcommits.org/en/v1.0.0/

中文 - https://www.conventionalcommits.org/zh-hant/v1.0.0/

格式:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

主要組件

  1. type(必填)
    表示提交的類型:

    • feat: 新功能

    • fix: 修復問題

    • docs: 文件更新

    • style: 格式(非代碼邏輯的變更,如空格、格式化)

    • refactor: 重構(既不是新增功能也不是修復問題)

    • test: 增加測試

    • chore: 更改建置工具或其他雜項維護

    • perf: 性能優化

    • ci: 持續整合相關變更

  2. scope(可選)
    說明變更的影響範圍(如模組名稱、功能)。

  3. description(必填)
    簡短描述變更內容。

  4. body(可選)
    更詳細的變更描述。

  5. footer(可選)

    • 通常用於關閉 Issue(例如 Closes #123)。

    • 或者寫明破壞性變更(如 BREAKING CHANGE: 描述破壞性變更)。

範例:

  1. 新增功能
git commit -m "feat(auth): add login functionality"
  1. 修復問題
git commit -m "fix(api): correct response format for user endpoint"
  1. 文件更新
git commit -m "docs(readme): update installation guide"
  1. 性能優化
git commit -m "perf(image): optimize image loading for faster page speed"
  1. 重構代碼
git commit -m "refactor(profile): simplify profile data fetching logic"
  1. 破壞性變更
git commit -m "feat(router): introduce new routing system
BREAKING CHANGE: the old routing system is deprecated"
  1. 關閉 Issue
git commit -m "fix(login): resolve login timeout issue
Closes #123"

完整提交範例

git commit -m "feat(cart): add ability to remove items from cart

This feature allows users to remove individual items from their cart.
It also updates the total price dynamically.

Closes #456"

More from this blog

關於 Hash index

什麼是 Hash Index? Hash Index 是資料庫系統中的一種索引結構,它使用雜湊函數(Hash Function)將索引鍵(Key)映射到資料表中的記錄位置。相較於傳統的 B-Tree 索引,Hash Index 在某些特定查詢場景下能提供更高效的性能。 基本原理 Hash Index 的核心原理是: 使用雜湊函數將索引鍵轉換為雜湊值(Hash Value) 雜湊值決定資料記錄在雜湊表(Hash Table)中的儲存位置 查詢時,系統對索引鍵應用相同的雜湊函數,直接定位到對應...

Jul 26, 20251 min read
關於 Hash index

Event Storming 演練 - 停車場系統 - 下

邊界情境 實際做法: 當大家走到「車輛靠近入口 → 辨識 → 進場」的事件時,突然有人問: 「那如果有人卡在入口不走呢?」 此時 facilitator(主持人)會立刻拿一張粉紅貼紙寫: 複製編輯🚧 車輛卡在入口太久 然後貼在「車輛靠近入口」的旁邊,不急著解決,先繼續主流程。 快速記錄格式(現場慣用) 元素怎麼寫 事件粉紅貼紙,寫「異常行為:XXX」 策略建議藍貼紙,可直接寫「應提示駕駛讓道」 命令建議黃貼紙,可寫「發送通知、記錄異常」 👉 不強求完...

Jul 10, 20252 min read

Event Storming 演練 - 停車場系統 - 上

領域專家口述業務流程 停車場入口會顯示目前停車場剩餘車位,當車輛駛入停車場入口,會先判斷是否有停車位,若是有停車位,車號辨視系統成功取得車號將會放入車輛進入,當感應車輛真的進入後,記錄車輛的車牌與其進入的時間,會將剩餘車位減一。 車輛進入之後,會給於一段緩衝時間,若是車輛在緩衝時間內出場,系統判斷可以正常出場不必繳納停車費用,若超過緩衝時間,即必須這行繳費程序之後再放行。 繳費流程要求在出場之前完成,不會與出場流程一起,繳費時會判斷是否在緩衝時間內,若是,將不必繳費請駕駛人儘快離場,並提醒剩於緩...

Jul 10, 20253 min read

TypeScript - Type 那點事

隨便記 將類型定義放在 .types.ts 或 .d.ts 檔案中,此兩者副檔名有何差異? 在 TypeScript 開發中,.types.ts 和 .d.ts 檔案都用於定義類型,但它們的用途和特性有所不同: .types.ts 用途: 通常用於在 TypeScript 專案內部,定義專案中使用的類型。 這些檔案包含 TypeScript 程式碼,可以包含類型別名、介面、列舉等。 .types.ts 檔案會被 TypeScript 編譯器編譯成 JavaScript 檔案(.js...

Jun 28, 20251 min read

碼農筆記 - 設計思維

Mark it Work, Mark it Right, Mark it Fast 可測試性 可閱讀性 可觀察性 可維護性 可擴展性 健壯性 安全性 效能與資源效率 可部署性 可配置性 🧠 最佳實踐心法 別一開始就追求 Make it Fast,先求穩定,再求優雅,最後才是效能。 重構是常態不是例外,Make it Right 應視為開發常規而非技術債還債。 性能瓶頸來自實測,而不是預測。 Make it Right 意指 程式碼結構清晰 命名具語意 關...

Jun 10, 20251 min read

我的工作筆記

8 posts

雖是全端碼農,主力還是後端功能,php + mysql + redis 使用 Laravel 框架,node + mysql + redis 使用 Adonisjs v5。