文件命名约定

如果你选择使用常见的文本文件来创建 ADR,那么你可能需要制定自己的 ADR 文件命名约定。

我们倾向于使用具有特定格式的文件命名约定。

示例:

• choose-database.md

• format-timestamps.md

• manage-passwords.md

• handle-exceptions.md

我们的文件命名约定:

• 名称使用一般现在时的祈使动词短语。这有助于提高可读性,并与我们的提交信息格式保持一致。

• 名称使用小写字母和连字符(与本仓库相同)。这是在可读性和系统可用性之间取得的平衡。

• 扩展名为 markdown。这便于简单地设置格式。