2012-01-05 73 views
7

我正在尋找一個解決方案,標記在提交信息的變更。標記提交信息和變更

對我來說,一個 「標籤」 是這樣的:

  • 代碼清理
  • 用戶可見的變化
  • 修改數據庫結構(ALTER TABLE)
  • 文檔變化

到目前爲止我使用SVN,但想切換到git。如果有標準的話,像trac,redmine等許多工具都可以使用它。

我希望這回答這樣的問題:

  • 如果我更新系統,什麼樣的變化是客戶可見,或 是它只是一個維持性更新?
  • 對數據庫架構兩個版本之間改變了嗎?

背景:

到現在我使用的齊聲DEV,TEST和PROD系統之間的同步。但是unison不知道版本管理(這是momement上的SVN)。我想切換到git。我希望看到更快,有什麼變化。

例如:我想看到TEST和PROD之間變化。我不想看到源代碼更改,但提交消息。但有時會有多達100次提交。這裏我想要一個過濾器,以排除不重要的變化。

回答

7

我喜歡使用以下標籤:

ADD adding new feature 
FIX a bug 
DOC documentation only 
REF refactoring that doesn't include any changes in features 
FMT formatting only (spacing...) 
MAK repository related changes (e.g., changes in the ignore list) 
TEST related to test code only. 

這個標籤是永遠的第一件事值的信息,然後接着從問題跟蹤系統的簡要描述和/或問題-ID,如果存在。

我使用svn和git標籤,到目前爲止發現它們非常方便。

爲了回答您的編輯: 這就是爲什麼我喜歡那些犯標籤。如果提交改變了行爲,它立即可見。如果你的數據庫計劃定期或如果這些變化或對你很重要的變化,你能給我介紹了一個標籤。

我也喜歡將這些標記合併到一個提交消息中。例如,「測試foo的測試DOC設置」。

通過額外的數據庫DB標籤,您可以輕鬆地跟蹤與數據庫相關的更改。

+0

+1爲好的答案。但是如果我需要使用其標籤獲取更多關於更改的信息呢?例如我需要更多關於在FIX標籤中解決的缺陷(其記者,關鍵性,再現步驟等)。 – hsalimi 2012-01-06 10:10:18

+0

然後,你可以添加所有這些信息的標籤之後,例如,「由李四報道FIX問題FOO; ......」 – mort 2012-01-06 11:24:37

+0

哦,天哪!!!!!!!那麼你要如何報告他們?????? – hsalimi 2012-01-06 13:29:54

1

我更喜歡爲我的問題跟蹤器中的問題分配每個更改集。使用已知的問題跟蹤器(如jira),可以選擇在更改集中解決的問題。選擇問題後,問題描述會自動放入更改集的消息中。他們可以在未來進行跟蹤,也可以在您的問題跟蹤器中進行報告。

+0

我更新了問題。這些標記應該回答這樣的問題:「如果我更新系統,什麼樣的變化是可見的客戶,或者是它只是一個維持性更新?」 – guettli 2012-01-06 08:01:36

+0

你如何處理未連接到問題提交?例如,如果您添加或更正某些文檔或重構某些內容? – mort 2012-01-06 08:51:25

+0

@guettli:所有這些信息都保存在您的問題中。此外,其他信息如一個要求的變化,這種變化對應用的源代碼的版本,第一個版本中,這些變化的影響,...被保持上的問題跟蹤器的問題。 – hsalimi 2012-01-06 10:06:15

3

大多數我使用的標籤系統從Typo3的時間:http://wiki.typo3.org/CommitMessage_Format_(Git)

它使用標籤犯這樣的消息:[TAG] Short message 當然,我一直在發行數量的雜音問題跟蹤。我們使用JIRA因此,它將成爲這樣的:[TAG] JIRA-123 Short message

TYPO3的標籤:

可能的標籤是:

  • [特點]:一個新功能(也小額外)。這很可能是一個附加功能,但它也可以被刪除。這隻能發生在v4的「主」分支上,因爲舊分支中不允許有新功能。與此相關的例外情況必須與相應的發佈經理按個案進行討論。
  • [修正]:修正了一個錯誤。
  • [任務]:任何以上類別未涵蓋的內容,例如編碼風格清理。
  • [API]:API已更改,方法或類已被添加或刪除;方法簽名或返回類型已更改。這只是指TYPO3的公開API。

另外其他標誌可能在某些情況下可以添加:

  • [!]:重大更改。在這個補丁之後,一些工作與以前不同,用戶/管理員/擴展開發者將不得不改變某些東西。應該只發生在「主」上。
  • [在製品]:工作進行中。一旦更改的最終版本可用,該標誌將被刪除。標記爲WIP的更改從不合並。
  • [安全]:可視化變更修復了安全問題。此標籤由安全團隊使用,萬一您發現安全問題,請務必先與安全團隊取得聯繫!

實施例主題描述:

  • [修正錯誤]扔HttpStatusExceptions在tslib_fe
  • [修正錯誤] [安全]在準備語句SQL注入漏洞
  • [功能] [CONF]添加選項隱藏列表中的BE搜索框mod
  • [!!!] [FEATURE]將高級前端編輯移至TER
  • [!!!] [TASK]從t3lib_userAuth
  • 刪除t3lib_sqlengine
  • [!!!] [API]刪除的方法已過時重定向()
  • [API]創建HTTP狀態異常的異常層次