アーキテクチャの履歴を残すフォーマット、ADRのメモ

Architectural Decision Records (ADR)

Neco プロジェクトのスキルチェックシート アーキテクチャの意思決定を記録する Lightweight Architecture Decision Records について

インストール

brew install adr-tools

初期化

adr init example-system

作る

adr new "サンプルADR"

/usr/local/bin/adr-new を修正する必要がある

本来だと、newするファイルは英語に限るのかもしれない。 ファイル名を修正している処理がある

slug=$(echo -n $title | tr -Ccs [:alnum:] - | tr [:upper:] [:lower:] | gsed -e 's/[^[:alnum:]]*$//' -e 's/^[^[:alnum:]]*//')

タイトルの大文字を小文字に変更している、などなど

このファイルに2点修正を加えている.

• sed を gsed を使うようにスクリプトを修正( brew install gnu-sed )
• ファイル名で英語限定にしている箇所を修正/ dstfile=$dstdir/$newid-$slug.md ↓ dstfile=$dstdir/$newid-$title.md タイトルをそのままファイル名にする