Zenn執筆時のコミットメッセージを考える
はじめに
ZennにはZenn CLIと呼ばれるコマンドラインインタフェース（CLI）があり、記事の管理をGitHubで行い、執筆をローカルのエディタで行うといった運用が可能となっています。
Zennの執筆環境周りについての説明は以下にまとめられています。
Webエディターだけに縛られることなく、Gitリポジトリで執筆や管理ができるといった執筆体験がとても新鮮だったというのが私のZennを積極的に使おうとしたきっかけの1つでもあります。
普段、プログラミングを学習する中でのアウトプットとしてZennに投稿する記事を執筆する中で、上記のZenn CLIを使って記事の管理をしています。
ローカルで記事を執筆し、GitHubリポジトリへプッシュすることで記事の更新が行えるのですが、その際にコミットメッセージをどのように編集してコミットするのがベストなのか悩むことがありました。
記事の執筆に関して、コミットメッセージを見るのは基本的に自分だけなので自分が見てわかればそれでいいというのはありますが、長い目で見ると分かりやすいことに越したことはないと感じます。
プレフィックスとは
プレフィックス（Prefix）という英単語は接頭辞という意味を持ちます。
GitHubのコミットメッセージなどで目にすることが多いです。
プレフィックスの種類、仕様は各々のプロジェクトによってルールが定められていることが多いようです。
フォーマットを統一することでコミット、コミットログの検索がしやすくなる、レビューをしやすくなるといったメリットがあるそうです。
フォーマットの統一ができ、それぞれのコミットの内容が見やすくなるという点では個人開発や、記事管理にも活用できると感じました。
個人的な運用について
コミットメッセージの先頭にプレフィックスを付与し修正内容の要点をメッセージとして添える短形式にするのが個人的に運用しやすいと感じました。
プレフィックスについては以下の記事を参考にしています。
上の記事ではともにangular.js/DEVELOPERS.mdが参考にされています。
Gitコミットガイドラインの中にプレフィックスとして8つ挙げられていますが、それぞれしっかりとした意味を持っており、分かりやすいと感じました。
これらを踏まえた上で考えた結果、個人的なプレフィックス運用方針は以下のようになりました。
| プレフィックス | ユースケース |
|---|---|
| update | 記事の内容を更新したとき |
| style | 記事の文体や構造を修正したとき |
| fix | 記事の誤字・脱字を修正したとき |
| publish | 記事をZennに公開したとき |
| chore | 執筆環境まわりの調整など |
あまり多くても管理が大変だというのと、プレフィックスについて悩む時間を減らしたいと考えた結果、上記の6つになりました。
まとめ
コミットメッセージにプレフィックスをつけることでログを見直したときに変更点を把握しやすいと感じました。
今までの記事管理のコミットメッセージのルールが定まっておらず、毎回コミットメッセージが煩雑化してしまっていたため、今後見直して統一化できるようにしたいです。
コミットメッセージは奥深く、gitmojiのように、コミットメッセージにかわいい絵文字を追加して視覚的にわかりやすくする手法もあります。
正解があるわけではないので、自分なりに使いやすい、分かりやすいと思える方法を模索していきたいところです。
最後まで読んでいただきありがとうございました。
Discussion