プラクティスは章に分かれています。各章には章の説明を書いたマークダウンファイルと、プラクティスの内容を記載したissueが用意されています。対応するissueの順番は章の説明マークダウンを読んで進めてください。issueは以下の流れで対応します。
GitHubのcloudnative-practiceリポジトリのIssuesタブを開き、プラクティス用のissueを確認します。
各章ごとにissueが作成されているので、内容を確認し、どのプラクティスを行うか決めます。
ブランチを作成する方法は2つあります。GUIとCLIのどちらか好きな方を選んでください。
issueのページ、右メニューのDevelopmentにあるCreate a branchをクリックしてブランチを作成します。ブランチ名は{issue番号}-{issueタイトル}の形式で作成されます。{issueタイトル}の部分は任意の文字列に変更して良いです。
ローカルにpullして作業ブランチを変更します。
git pull
git checkout {issue番号}-{issueタイトル}- mainブランチに移動します。
git checkout main
- mainブランチを最新の状態に更新します。
git pull origin main
- ブランチを作成します。以下コマンドでブランチの作成とブランチの変更を同時に行えます。
{issueタイトル}の部分は任意の文字列に変更して良いです。git checkout -b {issue番号}-{issueタイトル}
issueの内容に従ってコーディングを行います。コードの修正と必要なら環境へのデプロイも行います。
コーディングおよび実機での確認が完了したら、プルリクエストを作成します。以下の手順で行います。
- 変更をaddします。addの後に追加するファイルパスを指定します。
.の場合、カレントディレクトリ以下の全ての変更をaddします。git add . - 変更内容をコミットします。
git commit -m "#{issue番号} メッセージ" - 変更をリモートにpushします。
git push origin {ブランチ名} - GitHubの
cloudnative-practiceリポジトリのPull requestsタブを開き、New pull requestをクリックします。 compare:の部分で先ほどpushしたブランチを選択し、Create pull requestをクリックします。- タイトルと説明を入力し、
Create pull requestをクリックします。 - レビュアーを指定します。レビュアーは
@{GitHubアカウント名}の形式で指定できます。
レビュアーがプルリクエストを確認し、コメントや修正依頼を行います。本プラクティスでは開発のスピードと目的の明確化を重視するため以下の観点でレビューを行います。
- レビューで見る観点
- issueの内容に沿った実装になっているか
- コーディングルールに記載した最低限のルールに沿った実装になっているか
- レビューで見ない観点
- コードの品質やベストプラクティスに沿った実装になっているか
- コードの可読性や保守性
レビュアーからのコメントや修正依頼に対して、必要な修正を行います。修正が完了したら、再度コミットし、リモートにpushします。
git add .
git commit -m "#{issue番号} 修正メッセージ"
git push origin {ブランチ名}レビュアーは修正内容を確認します。追加でコメントがあれば、再度修正を行います。レビュアーが問題ないと判断したら、プルリクエストをレビュアーがマージします。レビュアーはマージした旨を作業者に伝えます。これでプラクティスの対応は完了です。
次のissueに進む前に、以下の手順を行います。
- 作業ブランチをmainに戻します。
git checkout main
- リモートのmainブランチを最新の状態に更新します。
git pull origin main
- 作業ブランチを削除します。
git branch -b {issue番号}-{issueタイトル}