こんにちは、フロントエンドエンジニアの峯です。
前回は CSS改行命令の「word-break」をご紹介しました。今回はgitを使ったプロジェクトなどでちょっと助かるgitの機能を紹介します！
目次
git管理で発生した課題
僕はWeb業界で仕事をするようになって、2年くらいになりますが、gitをプロジェクトで使い始めたのは今年に入ってからです。
それ故、仕組みやらコマンドやらを勉強し始め、ようやく慣れてきました。
そんな時、ちょっと大きなプロジェクトでgitを利用していると、ちょっとした問題が発生しました。
「あれ、、、このブランチ何やってたっけ？」
ブランチの数が増えてしまって、複数ブランチを並行して作業していると、作業進捗を忘れてしまいがちです。（これを思い出すのに、複数ページを行ったり来たり。）
ブランチにコメントを残しておこう！
そんな時に知ったのですが、ブランチにはコメントが残せます！
ブランチにコメントを残して進捗、次回のタスク等を残しておけば、ここで時間を取られることがなくなります！
という事で、今回はgitのブランチにコメントを残す方法を覚えていっていただければと思います！
ブランチにコメントを追加する
以下のコマンドでコメント入力画面（vi）が開きます。
git branch --edit-description {ブランチ名}
{ブランチ名}を省くと現在のブランチにコメントがつきます。
ここにブランチコメントを記載します！
# Please edit the description for the branch
# develop/branch_a
# Lines starting with '#' will be stripped.
~
~
...
"~/XXXXXXX/ZZZZZZZZ/.git/EDIT_DESCRIPTION" 5L, 161C
コメントを記入してからESC+:+w+qで保存して終了します。
(viコマンドの説明については省略します。)
ブランチのコメントを見る
ブランチにコメントを追加しました。
それでは追加したコメントを見てみましょう！
以下のコマンドで追加したコメントを閲覧できます。
git config branch.{ブランチ名}.description
いかがでしょうか？コメントが表示されましたか？
もちろん、--edit-descriptionコマンドを打てば編集もできるので、常に最新タスクを記入しておくなど、工夫して使うとすごく便利です。
さいごに
嬉しい機能ではありますが、コマンドが長くて辛いなと感じるので、その辺り簡素化できれば嬉しいですね。
エイリアスに登録してショートカットとして使うと解決できるようです！
（今回は機能のご紹介のため、割愛）
gitに限らず様々なツールが溢れていますが、やはり頭がいい人が作ったツールは、感じた課題を解決する機能がわりと用意してあるものですね。素晴らしいです。
ツールを使う我々はそれを使いこなす能力が必要だなと改めて感じます。
今回も最後まで読んでいただきありがとうございました。