Skip to content

Commit 4572089

Browse files
authored
Merge pull request #313 from smalruby/adr-what-to-describe-as-adr
docs: adr what-to-describe-as-adr [skip ci]
2 parents 761c556 + eb2db11 commit 4572089

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# What to describe as ADR and what not to describe
2+
3+
- Status: accepted
4+
- Deciders: takaokouji
5+
- Date: 2023-01-02T10:10:41:40+0900
6+
7+
Sorry, this is written in Japanese.
8+
9+
# なにをADRとして記述して、なにを記述しないのか
10+
11+
ADRを記述することにしたのはいいのですが、すべての意思決定をADRとして記述するのは現実的ではありません。
12+
13+
そこで、なにを記述して、なにを記述しないのかを決めます。
14+
15+
## 判断基準や制限
16+
17+
* 続けられること
18+
* スモウルビーは余暇をつかって開発しているため、作業時間の全体に限りがあること
19+
20+
## 選択肢
21+
22+
* 10分で書けそうなものだけADRに記述する
23+
* 1時間で書けそうなものだけADRに記述する
24+
* 意思決定のすべてにADRを記述する
25+
26+
## 決定
27+
28+
**採用:** 10分で書けそうなものだけADRに記述する
29+
30+
* 続けられるのを優先した。
31+
* 10分で書けるもの、または10分で書ける程度のメモ書きを残すことにする
32+
* 書き慣れてくると、10分で書ける内容が洗練されてくることを期待したい
33+
* ADRのブランチやコミットメッセージは以下に決めた
34+
* ブランチ名: `adr-%ファイル名から0001などの番号と拡張子を取り除いたもの%`
35+
* 例: `adr-what-to-describe-as-adr`
36+
* コミットメッセージ: `docs: adr %ファイル名から0001などの番号と拡張子を取り除いたもの% [skip ci]`
37+
* 末尾の `[skip ci]` は必須
38+
* PRのタイトルもコミットメッセージと同じものにして、CIをスキップすること
39+
40+
## 各選択肢の良い点と悪い点
41+
42+
### 10分で書けそうなものだけADRに記述する
43+
44+
* `+` 簡単に書けることが前提なので続けられそう
45+
* `-` 時間がかかりそうなものは中途半端な内容になったり、そもそもADRを残さなかったりする
46+
47+
### 1時間で書けそうなものだけADRに記述する
48+
49+
* `+` 10分で書けるものよりは、記録されている内容が増える
50+
* `-` 手間がかかる
51+
* `-` 面倒なので続かなくなる
52+
53+
### 意思決定のすべてにADRを記述する
54+
55+
* `+` 将来、なぜこうしたのか?を自分が知ることができる
56+
* `+` なぜこうしたのかを他人が知ることができる
57+
* `-` 手間がかかる
58+
* `-` 面倒なので続かなくなる

0 commit comments

Comments
 (0)