我應該在git commit消息中使用過去或現在式嗎？

Question

I read once該git提交消息應該處於現在時態，例如， 「爲x添加測試」。我總是發現自己使用過去式，例如「爲x增加了測試」，這對我來說更自然。

Here's a recent John Resig commit示出兩個在一個消息：

調整一些更多的jQuery設置在操作測試的結果。還修復了預期測試結果的順序。

重要嗎？我應該使用哪個？

Answer 1

現在時，命令式提交消息的優先級來自Git本身。從Git的回購Documentation/SubmittingPatches：

描述在祈使語氣，例如更改「make xyzzy do frotz」 而不是「[這個補丁]讓xyzzy做frotz」或者「[我]改變了xyzzy 做frotz」，就好像你正在給代碼庫下令以改變 它的行爲。

所以你會看到很多用這種風格寫的Git commit消息。如果你在一個團隊或開源軟件上工作，如果每個人都堅持這種風格以保持一致性，那麼這很有幫助。即使你正在開展一個私人項目，並且你是唯一一個能夠看到你的git歷史的人，但使用必要的情緒會很有幫助，因爲它確立了良好的習慣，當你與他人一起工作時，這些習慣會得到欣賞。

Answer 2

這取決於你。只要使用提交信息就可以了。 但是，如果不在時間和語言之間切換，則更容易。

如果你在一個團隊中發展 - 應該討論並設置它。

Answer 3

它有關係嗎？人們通常都足夠聰明，可以正確解釋消息，如果他們不是，你可能不應該讓他們訪問你的存儲庫！

Answer 4

堅持使用現在時態勢在必行，因爲

• 它的好，有一個標準的
• 它匹配在bug跟蹤門票其中自然有「落實的東西」，「修理東西」，或「形式測試一些東西。「

Answer 5

我寫了關於365git的更全面的描述。

使用命令式，現在時是一個需要一點 習慣。當我開始提及它時，遇到了 阻力。通常沿着「我所做過的提交消息記錄 」的行。但是，Git是一個分佈式版本控制系統，其中可能有很多地方可以從中進行更改。而不是編寫說明你已經完成的消息的 ;考慮這些 消息作爲應用提交將執行的操作的指示。 而不是具有與該標題提交：

Renamed the iVars and removed the common prefix.

有一個像這樣的：

Rename the iVars to remove the common prefix

告訴別人什麼申請，提交將做，而不是你做了什麼 。另外，如果你看一下你的資料庫的歷史，你會看到的Git生成的消息被寫在 這種緊張以及 - 「合併」不「合併」，「衍合」而不是「重訂」，所以在同一個 緊張的寫作不斷事情一致。它覺得很奇怪在第一，但它確實 是有意義的（可根據客戶應用推薦），並最終 變得自然。

說了這麼多 - 它是你的代碼，你的資料庫：這樣設置你 自己的指導方針，並堅持給他們。

但是，如果您決定採用這種方式，那麼git rebase -i與 reword選項將是一件好事情。

Answer 6

您的項目應該幾乎總是使用過去時。無論如何，項目應始終使用同一時態來保持一致性和清晰度。

我明白一些爭論使用現在時的其他論據，但他們通常不適用。下面的要點是用現在時的寫法和我的回答的共同論點。

• 在目前的緊張編寫告訴別人什麼應用承諾會做，而不是你做了什麼。

這是一個人想要使用現在時態的最正確的理由，但只有正確的項目風格。這種思考方式將所有提交視爲可選的改進或功能，並且您可以自由決定要在特定存儲庫中保留哪些提交和哪些提交。

這種說法工作，如果你正在處理一個真正的分佈式項目。如果您正在處理分佈式項目，那麼您可能正在開發一個開源項目。如果它真的分佈，它可能是一個非常大的項目。實際上，它可能是Linux內核或Git。由於Linux可能導致Git擴散並獲得普及，很容易理解爲什麼人們會將其風格視爲權威。是的，這兩個項目的風格很有意義。或者說，在一般情況下，它的工作原理與大，開源，分佈式項目。

話雖這麼說，在源代碼控制大多數項目沒有像這樣工作。對大多數存儲庫來說通常是不正確的。這是一種對提交進行思考的現代方式：Subversion（SVN）和CVS存儲庫幾乎不支持這種存儲庫檢入方式。通常情況下，一個集成分支處理過濾錯誤的簽入，但這些通常不被認爲是「可選的」或「很好的功能」。

在大多數情況下，當您向源存儲庫提交時，您正在編寫日記條目，該條目描述了此更新所做的更改，以便將來其他人更容易理解更改的原因。它通常不是一個可選的更改 - 項目中的其他人需要合併或重新綁定。你不寫日記，如「親愛的日記，今天我滿足一個男孩和他說我打招呼。」，而是你寫「我遇到一個男孩和他說打招呼我。」

最後，對於這樣的非分佈式項目，一個人讀取提交消息的時間有99.99％是用於閱讀歷史 - 歷史是以過去式讀取的。 0.01％的時間將決定他們是否應該應用此提交或將其集成到其分支/存儲庫中。

• 一致性。這就是它在許多項目中的情況（包括git本身）。還有生成提交（如git merge或git revert）的git工具。

不，我向你保證，大多數登錄過版本控制系統的項目都有過去式的歷史記錄（我沒有引用，但可能是正確的，考慮到現在時態是新的自Git）。使用現在時態的「修訂」消息或提交消息在真正分佈的項目中才開始有意義 - 請參見上面的第一點。

• 人們不僅讀歷史知道「發生了什麼事該代碼庫」，而且要回答諸如「當我摘櫻桃這次提交會發生什麼」的問題，或「會發生什麼樣的新東西我代碼庫，因爲這些提交我可能會或可能不會在未來合併「。

請看第一點。一個人讀取提交信息的時間爲99.99％，用於閱讀歷史記錄 - 以過去式讀取歷史記錄。 0.01％的時間將決定他們是否應該應用此提交或將其集成到其分支/存儲庫中。 99.99％勝過0.01％。

• 它通常較短

我從來沒有見過，說使用不當緊張/語法，因爲它是短的很好的理由。對於標準的50個字符的消息，您可能平均只能保存3個字符。話雖如此，現在時平均可能會縮短几個字。

• 您可以名與您的問題/功能跟蹤票的標題犯更一致（不過去時使用，雖然有時未來）

門票被寫成要麼東西，是目前（例如，當我點擊此按鈕時，應用程序顯示錯誤的行爲），或者將來需要完成的事情（例如文本需要審閱編輯）。

歷史（即提交消息）被寫爲過去完成的事情（例如，問題是是固定的）。

Answer 7

你在爲誰寫信息？那麼讀者通常是在自己擁有提交之前閱讀郵件前的消息嗎？

我認爲這裏給出的答案都是從兩個角度出發，我可能只是沒有建議每個項目都有最佳答案。分組投票可能會提出同樣多的建議。

即來概括：

• 主要是消息對於其他人，通常在一些點讀，他們所承擔的改變之前：什麼服用變化會做他們的現有代碼的建議。

• 信息主要是作爲您自己（或您的團隊）的期刊/記錄，但通常從已經承擔變化和搜索以發現所發生的事情的角度閱讀。

也許這會爲您的團隊/項目帶來動力，無論哪種方式。