- なぜこの変更をするのか、
- 課題は何か、
- これによってどう解決されるのか、
- など、この変更に対する概要を記載
- 環境変数やSSMパラメータに変更を加えたか否か
- 変更したとしたらどのような変更か
- 変更した場合は以下の作業を行う
- ssmリポジトリに該当の値を追加し本PRと同時にPRを出す
- ステージング環境のSSMへ該当のパラメータを追加
- Slackでエンジニア全員へこのPRの内容を共有
- 必要であれば
.envrc.sampleへ環境変数名とその用途の詳細な説明を追加 - 必要であればmasterへマージされた時に走るCI環境への追加
- 必要であればCircleCI Contextsにも追加
- 影響を与えるユーザは誰か
- 影響を与えるシステムはどこか
- サーバレス
- フロントエンド
- プライベートチェーン
- 開発チームに共有すべきことはあるか
- 環境構築手順に変更はあるか。
- ある場合は手順を更新: http://bit.ly/30bfDZF
- 環境構築手順に変更はあるか。
- なにをどう変更したか
- ロジックがどういう手順で動くのか、
- DBからどういうクエリで何をとってそれに何を処理するのか、
- 使い方の説明
- バグの場合は再現条件
- DBのスキーマに変更があるか
- 変更がある場合はドキュメントに反映
- 変更されるクエリはあるか
- あるならどのような変更か
- 変更前:
- 変更後:
- あるならどのような変更か
- 新規に追加されるクエリ
- 観点:
- index周りの指定は適切か
- 想定される対象のデータ量
- 想定されるデータ量が大量のとき大丈夫か (ダメな場合、いつまでにどうにかする予定があるのか、忘れないために別チケットを用意したか)
- ブロックチェーンを参照するか
- ブロックチェーンへのトランザクションが発生するか
- Yes
- 投げ銭におけるワンタイムトークンなど、フロントエンドに対してフェイルセーフな設計となっているか
- No
- 無い
- ある
- あるとしたらその修正内容をConfluenceにまとめたか
- 無い
- ある
- あるとしたらその修正内容はコード化したか
- 無い
- ある
- あるとしたらその修正をCIへ反映したか
- メールアドレスや住所情報等、個人情報にあたるものは細心の注意が必要
- CloudWatch等、AWS標準以外のログを考慮する必要があるか
- あるとしたらいつ、どこで、なぜ、どこに、どのようなログが吐かれるか
- アラームが必要か
- 必要
- 不要
- 必要な場合はアラームをコードに追加したか
- した
- していない
- ユニットテストが書かれているか
- 書かれていない場合、妥当な理由があるか。それは何か
- テストする際の項目を、このように、チェック可能な形式で記載する。
- テストしたらチェックを入れていく。
箇条書きで書く。可能な限り次のチケットを作る。
- この作業で特に注意する点があれば記載する
- その他、補足事項があれば記載する
- 内容を確認し、問題なければマージしてください。