Architecture Decision Record

Active theme: Light

← 文件

ADR 檔案命名慣例

如果你選擇用一般文字檔案嚟建立 ADR,咁你可能想訂立自己嘅 ADR 檔案命名慣例。

我哋傾向用有特定格式嘅檔案命名慣例。

例子:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

我哋嘅檔案命名慣例:

  • 名稱用現在式祈使動詞短語。咁樣有助提高可讀性,亦同我哋嘅提交訊息格式一致。

  • 名稱用小寫字母同連字號(同本儲存庫一樣)。呢個係可讀性同系統易用性之間嘅平衡。

  • 副檔名係 markdown。咁樣方便排版。