Zenn執筆時のコミットメッセージを考える

commits2 min read読了の目安(約2100字

はじめに

Zenn には Zenn CLI と呼ばれるコマンドラインツールがあり、記事の管理を GitHub、記事の執筆をローカルのエディタを使うといった執筆が可能となっています。

Zenn の執筆環境周りについての説明は以下の公式記事にまとめられています。

https://zenn.dev/zenn/articles/editor-guide

Web 上のエディターだけに縛られることなく、記事の執筆、記事のバージョン管理ができるといった執筆体験がとても新鮮だったというのが私の Zenn を積極的に使おうとしたきっかけの 1 つでもあります。

普段、プログラミングを学習する中でのアウトプットとして Zenn に投稿する記事を執筆する中で、上記の Zenn CLI を使って記事の管理をしています。

ローカル環境で記事を執筆し、Zenn に連携された GitHub リポジトリへプッシュすることで記事の更新が行えるのですが、その際にコミットメッセージをどのように編集してコミットするのがベストなのか悩むことがありました。

記事の執筆に関して、コミットメッセージを見るのは基本的に自分だけなので自分が見てわかればそれでいいというのはありますが、やはり管理するうえでわかりやすいことに越したことはないと感じます。

プレフィックスとは?

プレフィックス(prefix)とは英語で接頭辞のことです。

Github のコミットメッセージを見るとき目にすることが多いです。
使用するプレフィックスの種類、プレフィックス仕様の有無などは各々のプロジェクトによってルールが定められていることが多いようです。
プレフィックスを適切につけコミットログのフォーマットを統一することでコミット、コミットログの検索がしやすくなる、レビューをしやすくなるとったメリットがあるそうです。
フォーマットの統一ができ、それぞれのコミットの内容が見やすくなるという点では個人開発や、記事の管理にも活用できると感じました。

個人的な運用について

コミットメッセージの先頭にプレフィックスをつけワンライン(1 行)形式にするのが個人的に運用しやすいと感じました。

プレフィックスについては以下の記事を参考にしています。

https://qiita.com/numanomanu/items/45dd285b286a1f7280ed
https://qiita.com/konatsu_p/items/dfe199ebe3a7d2010b3e

上の記事ではともにangular.js/DEVELOPERS.mdが参考にされています。
Git コミットガイドラインの中にプレフィックスとして 8 つ挙げられていますが、それぞれしっかりとした意味を持っており、プレフィックを見ただけで意味がわかりやすいと感じました。

これらを踏まえた上で考えた結果、個人的なプレフィックス運用方針は以下のようになりました。

プレフィックス どんなときにつけるのか
add: 新規に記事を作成したとき
update: 記事を更新したとき
fix: 記事の誤字脱字などを修整したとき
publish: 記事を公開したとき
upgrade: ZennCLI 自体のアップデートがあったとき

あまり多くても管理が大変というのと、プレフィックスについて悩む時間を減らしたいと考えた結果、上記の 5 つになりました。

まとめ

今までコミットメッセージにプレフィックスをつけずにコミットしていましたが、プレフィックスが付くことでパッと見で変更点を把握しやすいと感じました。

今までの記事管理のコミットメッセージのルールが定まっておらず、毎回コミットメッセージが煩雑化してしまっていたため、今後見直して統一化できるようにしたいです。

調べる中でプレフィックスに絵文字を含め視覚的にわかりやすくするなど、工夫次第でかなり便利に活用できると感じました。
コミットメッセージには正解がないため、どのように運用するかを様々なリポジトリやドキュメントを見ながら吟味していくのも楽しいです。私も自分の中でのベストプラクティスを模索中なので今後執筆を続けていく中で、もっと改善していきたいです。

最後まで読んでいただきありがとうございました。