はじめに
前回、gitlabでissueの作り方を投稿しているので、今回はMergeRequestの作り方について書いていきます。
MergeRequestとは
ドキュメント・ソースコード等を追加・修正・削除したブランチを、別のブランチにマージ（反映）する許可を得るための承認作業のことです。
GitHubだと、プルリクエスト(Pull Request)のことを指します。
MergeRequestの作り方
MergeRequest(MR)を作る方法は2種類あります。
作成方法は以下に記載しています。
※マージリクエストをMRと称して記載しています。
新規でMRを作る
-
サイドバーのコードをクリックし、マージリクエストをクリックします。
- MRの一覧が表示されます。この画面の
新しいマージリクエストボタンをクリックします。※下記はMRがない場合の画面です。
- 以下の画面が出るので、ブランチを選択します。ソースブランチは
自分の作業ブランチ、ターゲットブランチに任意のブランチを指定します。 - 指定後、
続行するボタンをクリックします。
- マージリクエストの説明やタイトルを入力していきます。
-
MR作成ボタンをクリックしたら完了です。
issueからMRを作る
- issueの詳細を表示します。
-
マージリクエストを作成ボタンをクリックすると、自動でブランチとMRが作成されます。 - マージリクエストを作成ボタンの右にある
∨をクリックすると、どのブランチから作業ブランチを作成するのかやブランチ名を自分で命名できます。命名時は何の作業をするか分かるようにしましょう。
- 新規MRの手順4.以降同じです。
MRの項目
MR作成時に意識することを項目毎に記載してます。
| 項目 | ポイント |
|---|---|
| タイトル | タイトルを見ただけで、MRの概要が分かるようにしておきましょう。 |
| テンプレート | プロジェクトによってはテンプレートが用意されているので、のルールに沿って設定してください。 |
| 説明 | このMRは何をするMRなのか記載します。何をレビュアーに確認してほしいのか、目的とアクションする内容を明確に記載します。 |
| 担当者 | このMRの発行者です。 |
| レビュアー | このMRをレビューしてもらう人です。 |
| マイルストーン | マイルストーンを設定します。何を設定するか不安な場合は、上司や管理者などに相談しましょう。 |
| ラベル | プロジェクトによってはラベルを用意してあるので、そのルールに沿って設定してください。 |
マージオプションにチェックを付けたときはマージ時に以下の動作をします。
上段のチェックボックス： マージ時に作業用ブランチを削除します。(リモートブランチのみ)。
下段のチェックボックス: マージ時にコミットをひとまとめにします。
MRのテンプレート
ここでは、MRのテンプレートを記載しています。
あくまで具体例ですので、応用などは各々でお願いします。
# 概要
XXX.pyの開発(タイトルと同じでもOK)
{課題番号}-ISSUE_NAME //issueとの紐づけ
## 開発内容
- [ ] 大まかな開発内容を
- [ ] 箇条書きで簡潔に
- [ ] 書く
## 特にチェックをお願いしたい箇所(レビュー観点)
- [ ] 不安な部分、レビュー観点を
- [ ] 箇条書きで簡潔に
- [ ] 書く
## その他になるところや、添付画像など
依頼内容と違うけれど、こうしたほうがいいかも？など気づいたことなどを書く。
おわりに
今回はマージリクエストの作り方について記載しました。
もし、MRのテンプレートでこうした方がよりいい。などがありましたら、コメントで教えていただけると嬉しいです。
今後もGitLab関連の記事を記載予定ですので、興味があれば、次の記事なども見ていってください。
GitHubで編集を提案
Discussion