descriptionとは
コミットメッセージの下記の位置に表示される文章。コミットログなどには表示されないので、文字数などを気にせずに詳細情報を記載することができる。
VSCodeのGit連携機能を使用した書き方
入力欄で改行して2行目を空行にするだけ。Enterで改行できる。1行目はtitle、3行目以降は全てdescriptionとして登録される。
表示確認
git log
titleのみ表示される
git log --all
descriptionも表示される
プルリクエストのコミット履歴
titleのみ表示される
コミット詳細ページ
descriptionも表示される。（「descriptionとは」にも貼ってるけど一応貼っておく）
ちなみにコマンドでdescriptionを登録するには
下記の書き方でOK
git commit -m 'titleだよ' -m 'descriptionだよ'
参考