README

一个用于处理架构决策记录（ADRs）日志的命令行工具。

快速开始

使用 adr 命令来管理 ADRs。尝试运行 adr help。

ADRs 存储在项目的子目录中，作为 Markdown 文件。默认目录是 doc/adr，但您可以在初始化 ADR 日志时指定目录。

在项目根目录下创建一个 ADR 目录
```
 adr init doc/architecture/decisions
```
这将创建一个名为 doc/architecture/decisions 的目录，其中包含第一个 ADR，记录您正在使用 ADRs 来记录架构决策，并链接到Michael Nygard 关于此主题的文章。
创建架构决策记录
```
 adr new Implement as Unix shell scripts
```
这将创建一个新的编号 ADR 文件并在您选择的编辑器中打开它（由 VISUAL 或 EDITOR 环境变量指定）。

要创建一个新的 ADR 以替代先前的 ADR（例如 ADR 9），请使用 -s 选项。
```
 adr new -s 9 Use Rust for performance-critical functionality
```
这将创建一个新的 ADR 文件，并标记为替代 ADR 9，并将 ADR 9 的状态更改为表示它已被新的 ADR 替代。然后，它将在您选择的编辑器中打开新的 ADR。
有关更多信息，请使用内置的帮助
```
 adr help
```

请参阅测试以获取详细的示例。

此工具的决策记录在项目存储库中的架构决策记录中。