Gadget 33：更新ログの書き方

更新履歴・CHANGELOG の書き方ガイド（誰にでも伝わる記録のルール）

更新ログの書き方

「この更新で何が変わり、壊れる恐れはあるか」を次の人・自分に伝える記録のルールです。

目的

  • 更新履歴を検索・レビュー可能にする
  • 破壊的変更の通知を忘れない

前提条件

記録のルール

1. 1 変更 1 行、形式は一定に

## 2026-08-10
- 変更: 監視閾値（CPU 80%→85%） — {改め手順: cfos-monitor.sh}
- 追加: DNS 切り分けガイド
- 修正: コールバック URL の完全一致の注意書き

2. 破壊的変更は必ず「注意」をつける

- 変更（注意）: 既定 admin を除去（外部公開前提）。既存利用者の再登録が必要

3. 単語の約束

語 意味 例
追加 新機能・新ページ Gadget 33 を追加
修正 不具合・誤記の修正 OAuth 手順の誤り修正
変更 挙動・設定の変更 閾値を変更
破壊的変更 後方互換なし admin 仕様の変更

手順

  1. 変更前に「これは破壊的か」を判断し、あれば冒頭に明記
  2. 変更 1 つ = 1 行で書く（diff と対応が取れる粒度）
  3. 日付＋誰（git の author があれば十分）
  4. 変更後チェック（31）の結果も 1 行添える

よくある失敗

症状 原因 対処
何が変わったかわからない 粒度が太い 1 変更 1 行を守る
破壊的変更の事前通知がない 判断漏れ 変更前に必ず判定
履歴はあるが検索不能 用語がバラバラ 語彙（追加/修正/変更）を統一
更新ログと実際が違う 記録漏れ 変更と同時にコミット

確認

次に読む