目前使用Git 一段時間,這邊做個筆記關於如何寫好一個commit這件事
1. 第一個字大寫
(X) add something to somewhere
(O) Add something to somewhere
2. 不加句點
(X) Add something to somewhere.
(O) Add something to some where
3. 描述修了什麼樣的Bug,非描述怎麼修Bug
(X) To change B way from A on XXX_function to avoid getting crash
(O) Fix XXX_function to avoid getting crash
4. commit除了改了什麼以外,也要加個理由
(X) Use pthread instead of semaphore
(O) Use pthread instead of semaphore for <reason what>
PS. Bug怎麼修可下以下指令去查看
git log -p <commit-id>
Change log
2017/06/16 First Adding
2017/08/20 Add number 4th item