見出し画像

Step4:Github上でレビュー依頼実施(新人がアプリチームの一員になるまで)【Xcode&Github】

こんにちわ。素未(スミ)です。
本日は、合同会社ワインスキャンにおいて行なっているアプリ開発において

Github上でレビューの依頼を実施する

をご紹介致します。
なお、この方法は下記のバージョンを活用して行なっている状況でありバージョン変更に伴い使えないなどが起こった場合は、ご了承ください。


Xcode 13.4.1
iOS 15
Swift 5.5
Git version 2.32.1 (Apple Git-133)
PC:MacOS Monterey 12.6


弊社のサイト紹介(合同会社ワインスキャン)
ご興味があれば是非!見て下さい。


それでは、本題に入りたいと思います!今までの前提と最終アウトプットに変更はありません。

【前提】あなたは新しくプロジェクトメンバーにアサインされた新人社員とします。そのため、前からプロジェクト自体は存在し、GithubとXcodeを活用したプロジェクト開発が進んでいる状態とします。

今回のあなたの最終アウトプットは、

「新規プロジェクトで初めてタスクを依頼され、そのタスク内容を大元のコードに反映し、自分が実施したタスクを完了させること」

です。その為、今回はレビュー依頼側となります。

大きくステップは下記になります。

①ターミナルを活用し、Githubの設定を行う
②リモートリポジトリからのプロジェクトを自分のローカルリポジトリで取得する
③自分が割り当てられた部分のコードを修正できる環境を準備する
④Github上でレビューの依頼を実施する
⑤レビューを対応したらマージを行う
⑥自分が行ったタスクの整理・整頓を行う

※一部修正

それでは、頑張っていきましょう!
※本記事は下記の状態ができる様になります。

③Github上でレビューの依頼を実施する

前回の内容で、自分のローカルリポジトリで修正ができる状態を確立することができましたね。

今回は、自分の作成したコードに対してレビューを依頼することを実施しましょう!

修正状態の確認

自分のローカルリポジトリでのXcode上での修正が終わり、buildも実施することでエラーが出力されていない状態を構築できたとします。
※注意:buildが通っていない状態でレビュー依頼をすることは、ダメです!切符を購入していないのに電車に乗るくらいダメです!!!!!

必ず、buildを行い、エラー・ワーニングが出力されていない状態になっていることを確認して下さい。

一通り自分のローカルで修正を加えることができましたら、下記のコマンドをターミナルに代入し、修正したファイルの有無を確認して下さい。

git status

このコマンドを代入すると、

「あなたの変更はこのファイルに修正を加えていますよー。」

という状態を赤色で表現してくれます。
自分が修正した内容が問題ない場合は、

git add .

と入力し、新しい変更は正しいです!という状態にして下さい。
その後、Githubではいろいろな修正が含まれてくる(人が多いとその分、変化点が多い)ため、

「私の変更はこの様な意味ですよー」

という状態を付帯することができます。

git commint -m "XXXXXXX"

※XXXXX:説明文

これで、何の変更ですよ!と言う言葉を保存することができました。

リモートリポジトリに適応する

続いては、リモートリポジトリ(皆が参照することができるメインのフォルダ)に対して、自分が変更したことを適応する処理を行いましょう

git push origin Sumi/add_figureView#1

originの中に、Sumi/add_figureView#1の修正した内容を、リモートリポジトリに追加します!と言った内容になります。

これでGithubyのURL上では、
”あなた、新しいプルリク上げましたね?レビューを開始しますか?”
と言った問いがきます。

そこで、もちろんYESと設定して頂きまして、Github上での詳細な説明を加えましょう。

弊社では、誰でもレビューを行うことができる様に、テンプレートを設定しています。

Close #XXX  
何のissueと関連がありますか?
概要
どんな内容ですか?
背景
なぜ、それを行う必要がありますか?
やったこと
実装上何を行いましたか?
やっていないこと
今回の対応として含まれていないことは何ですか?
変更内容
どのファイルに対して、何を変更しましたか?
影響範囲
他の人に対して何か懸念がありますか?
テスト方法
何を根拠に確認し、レビュー依頼をしていますか?
課題
目標としている内容に対して、乖離がある部分は何ですか?
備考
なにかあれば。
レビュー担当者(以下のうち1名)
誰に見てもらいたいですか?

これにより、何ができて何ができていなくて、今後を見据えると何が課題・問題になりそうか。と言う「当事者意識」での展開を実現しています。

各々、初めてのことで挑戦となり新しく得る分野・知識が多数発生します。
しかし各々が行なっていることは、各々が考えた上で実施できているアクションでもあります。そのため、

上記の内容に、どの様な考えで取り組んだ内容なのか。

と言う部分について重点を置いています。分からないことは分からないと述べることに何も悪くありません。チームで一緒に解決していきましょうじゃないですか!

ここまでの内容で、自分の修正内容を、リモートリポジトリ上へプルリクをあげる(レビュー依頼)をすることができていますので、あとは他の方のレビューを待ちましょう

以上で、チームのメンバーに対してレビュー依頼を実施する手段について記載をさせて頂きました。

それではこれで第4ステップは終了となります。

①ターミナルを活用し、Githubの設定を行う
②リモートリポジトリからのプロジェクトを自分のローカルリポジトリで取得する
③自分が割り当てられた部分のコードを修正できる環境を準備する

④Github上でレビューの依頼を実施する
⑤レビューを対応したらマージを行う
⑥自分が行ったタスクの整理・整頓を行う

次は、

レビューを対応したらマージを行う

となります。よろしくお願い致します。
あと少しですね!頑張りましょう!

よろしければサポート頂けると幸いです!子供へのパパ時間提供の御礼(お菓子)に活用させて頂きます☆