初めに
前のインターンを応募した企業でマージリクエストを利用した開発を行わせていただきました
そこでマージリクエストの重要性を教えていただきました
そのフィードバックを元に自分ならどのようにマージリクエストを作成するかを考えたので
紹介します
マージリクエストの概要
- 実装概要
- どのように実装したか
- 開発していてわからなかった部分
- テスト項目と確認したことについて
この4項目を書くようにしています
実際にマージリクエストを作成してみた例
タイトル
ログイン画面の作成
ここではマージリクエストのタイトルを決めます
できるだけわかりやすく簡潔に伝えられるようにタイトルを作成します
実施概要
html,cssを使ってログイン画面を実装した
どのようなことをしたのか概要を伝えます
ここでもあまり長くなりすぎず簡潔に伝えられるように概要を作成します
どのように実装したか
ヘッダー、フッターはホーム画面と同様に実装した
ログインフォームのhtmlの説明は
フォームの名前はh1タグを使用した
formタグを使用してaction属性にread.html、method属性にpostメソッドを指定した
またcssの説明は
mainタグでフォーム内の要素の真ん中寄せ、と枠線の指定を行った
formタグで要素を縦並びにするように設定した
inputタグのid属性それぞれで線、余白、位置、色の調整を行った
ここでは実装の内容を具体的に書くようにします
それぞれの処理をどのように実装したのかを明確に伝えるようにします
開発していてわからなかった部分
フォーム自体を真ん中に寄せる方法についてmarginで調整する方法であっているか知りたい
ヘッダーとフッターの位置を固定する方法があれば知りたい
ここがフィードバックを得て大事だと考えた部分の1つ目です
チーム開発で大事なこととしてリクエスト先のエンジニアの方の負担にならないように行動する
というのが挙げられると思います
私はそこを意識してリクエストを送信していました
なので評価としてよかったので絶対書くようにしています
わからないことがない方がよいと思うのですが
悩みすぎて自分の開発が進まずチームに迷惑をかけてしまうよりも
わからない部分を明確にして教えていただいた方が開発スピードが上がると考えてます
でも丸投げするのではなく日頃から自分で考えられるように訓練することも大事だと考えています
テスト項目と確認したことについて
ヘッダー関連
- 「todoカンリ」を押してホーム画面に飛ぶことができるか
- 「todoカンリ」ボタンの位置が仕様に合っているか
- ヘッダーの背景色がオレンジになっているか
メイン関連
- フォームが真ん中にあるか
- メールアドレスが入力できるか
- パスワードが入力できるか
- 送信ボタンを押すと一覧画面に飛べるか
フッター関連
- フォントの色が白になっているか
- フォントが中央揃えできているか
- 背景をオレンジになっているか
ここがフィードバックを得て大事だと考えた部分の2つ目です
チーム開発で使用通りに作成するというのはタスクを行うエンジニアにとって大事なことであると考えています
デグレ、出戻りを発生させないためにもテストと確認を行ったことを示すことはマージリクエストには必要であると考えます
終わりに
企業ごとに決め事はあると思いますが
gitflowの意識やマージリクエストでわからないことまた仕様の確認テストを行う意識は重要であると思うので
意識して取り組んでいこうと思います