- この変更が必要な理由は何か?
- これによってどう解決されるのか
- など、この変更に対する概要を記載
- SSMに変更を加えたか否か
- YES or NO
- SSMを変更した場合は以下の作業を行う
-
ssmリポジトリへ環境変数名とその用途の 詳細な説明 を追加 - Slack でエンジニア全員へ、この PR の内容とSSMへ変更があったことを共有(マージ時)
- 必要があれば、master へマージされた時に走る CI 環境への追加(Context)
- ビルドやローカルでの開発で必要な場合は、
build.shや.envrc.sampleに追加
-
- 環境変数に変更を加えたか否か(注:原則としてSSMを使用し、環境変数は使用しない)
- YES or NO
- SSMではなく環境変数を使用した理由は合理的理由は何か
- YES or NO
- 影響を与えるシステムはどこか
- 例: 記事一覧画面
- 例: プロフィール設定画面
- なにをどう変更したか
- ロジックがどういう手順で動くのか
- バックエンドからどういうクエリで何をとってそれに何を処理するのか
- 使い方の説明
- バグの場合は再現条件
- E2E テスト戦略 でテストすべき項目が担保できていること
- テストする際の項目を、このように、チェック可能な形式で記載する。
- テストしたらチェックを入れていく。
箇条書きで書く。可能な限り次のチケットを作る。
- この作業で特に注意する点があれば記載する
- その他、補足事項があれば記載する
- 例: 内容を確認し、問題なければマージしてステージングで動作確認をお願いします。その後、リリースしますのでお知らせください。
