最近、開発環境のテンプレート構築をしているのですが、「git commit するまえに考えるべき10のこと | Act as Professional – hiroki.jp by HIROCASTER」みたいに、ソースコードのバージョン管理を実際に始めるときに理解しておかないといけないことは、結構あるはずです。
それで、ソースコードのバージョン管理については、git commitするときに記録するコメントについて、いろいろと考えることもあります。Git Styleは「git/Documentation/SubmittingPatches at master · gitster/git · GitHub」にありますから、こういうのも参考になります。
- 英語で記述
- 一文の場合、文末にピリオドを付けない
- 主語は省く
- 時制は現在形
- 文頭の英単語は大文字
他にもないかなぁ、と探してみたら「Changelogのための英文テンプレート集 – ぴょぴょぴょ？ – Linuxとかプログラミングの覚え書き –」という良いページがありました。2007年の記事ですが、最終更新2012/5/2となっているのでバージョンアップがされ続けているようで、参考になります。
いくつか紹介します。
- バグ修正 … Fix
- 修正 … Modify
- 変更を取り消し … Revert
- 回避 … Avoid
- 新規機能追加 … Add
- 新規 … New
- 仕様変更 … Change
- 小さな変更 … Minor changes
- 大きな変更 … Major changes
- 改良 … Improve
- バージョンアップ … Upgrade
- 更新 … Update
- 機能拡張 … Extend
- 機能向上 … Enhance
- 最適化 … Optimize
- 有効化 … Enable
- 無効化 … Disable
- 減量 … Reduce
- 整理 … Clean
- 削除 … Remove
- 設定 … Set
- 設定解除 … Unset
下記が参考になるそうです。
- http://www.php.net/ChangeLog-5.php
- http://www.kernel.org/
- http://www.nvidia.com/
- http://usebb.sourceforge.net/cvs/Changelog.txt
- http://www.apache.org/
Gitについては下記のような参考書があります。