Architecture Decision Record

Active theme: Light

← ドキュメント

ファイル名規則

通常のテキストファイルを使用して ADR を作成する場合は、独自の ADR ファイル名規則を考案するとよいでしょう。

私たちは、特定の形式を持つファイル名規則を使用することを好みます。

例:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

私たちのファイル名規則:

  • 名前には現在形の命令形の動詞句を使用します。これは可読性を高め、私たちのコミットメッセージの形式とも一致します。

  • 名前には小文字とダッシュを使用します(このリポジトリと同じ)。これは可読性とシステムの使いやすさのバランスです。

  • 拡張子は markdown です。これは、簡単な書式設定に役立ちます。