概要
下記の記事を読んで、GitHubのプルリクエストの書き方とかが参考になったので記事内にあるフォーマットを拝借して仕事で使うGitLabのマージリクエストを書き直してみた。 実際に書き換えようとするとUI変更箇所のbefore/afterの画像を貼り付けてたりしたので下のほうにあるコンテンツにたどり着くのにスクロールしなきゃいけないなぁというくらい長くなってしまった。 試した結果、長めのブログエントリみたいに目次が必要だと思ったのでマージリクエストに目次を作ってみた。
やってみる
GitLabは GitLab Community Edition 10.1.1 を使用した。
マージリクエストの本文は以下のようなものだとする。
# このマージリクエストは何なのか？（やったこと） # チケット # 重点的に見て欲しいところは？ (不安なこと) # どんなテストをしたか？ # ローカルで動かしたくなったときの手順
h1、h2タグなどのヘッダーを作るとprefixに #user-content-というid属性のつくタグが生成される。注意点は ? や ( や ) や空白は無視されること。
それを考慮して目次をつくると以下のようになる。
- [このマージリクエストは何なのか？（やったこと)](#user-content-このマージリクエストは何なのかやったこと) - [チケット](#user-content-チケット) - [重点的に見て欲しいところは？ (不安なこと)](#user-content-重点的に見て欲しいところは不安なこと) - [どんなテストをしたか？](#user-content-どんなテストをしたか) - [ローカルで動かしたくなったときの手順](#user-content-ローカルで動かしたくなったときの手順)
