檔案命名約定

如果你選擇使用常見的文字檔案來建立 ADR,那麼你可能需要制定自己的 ADR 檔案命名約定。

我們傾向於使用具有特定格式的檔案命名約定。

範例:

• choose-database.md

• format-timestamps.md

• manage-passwords.md

• handle-exceptions.md

我們的檔案命名約定:

• 名稱使用一般現在時的祈使動詞短語。這有助於提高可讀性,並與我們的提交資訊格式保持一致。

• 名稱使用小寫字母和連字元(與本儲存庫相同)。這是在可讀性和系統可用性之間取得的平衡。

• 副檔名為 markdown。這便於簡單地設定格式。