svn提交規範

聆湖聽風發表於2023-03-14

本文件參考了Git提交規範,旨在規範使用SVN進行程式碼版本管理時的提交操作。

提交前的準備

1. 檢查程式碼

在提交程式碼前,請先進行必要的程式碼檢查,確保程式碼的正確性、可讀性和可維護性。可以使用程式碼質量管理工具進行自動化檢查,也可以手動檢查。

2. 編寫提交資訊

在提交程式碼時,需要編寫提交資訊來描述本次提交的內容。提交資訊應包括以下內容:

  • 本次提交的目的或原因
  • 本次提交的變更內容
  • 其他有關本次提交的說明資訊

提交資訊應遵循以下格式:

<type>(<scope>): <subject>

<body>

<footer>

其中,<type> 代表本次提交的型別,包括以下幾種:

  • feat:新功能(feature)
  • fix:修補 Bug
  • docs:文件(documentation)
  • style:格式(不影響程式碼執行的變動)
  • refactor:重構(即不是新增功能,也不是修改 bug 的程式碼變動)
  • test:增加測試
  • chore:構建過程或輔助工具的變動

<scope> 代表本次提交的影響範圍,可以省略。

<subject> 代表本次提交的簡要說明。

<body> 代表本次提交的詳細說明,可以省略。

<footer> 代表本次提交的備註資訊,可以省略。

例如:

feat: 新增登入功能

為網站新增了登入功能,並引入了 OAuth2.0 認證。

Closes #123

提交操作的規範

1. 提交頻率

請根據實際情況適當控制提交的頻率。過於頻繁的提交會增加版本控制系統的負擔,也會給其他開發人員帶來不必要的干擾。

2. 提交檔案

請只提交與本次提交相關的檔案,不要提交無關檔案或者未經修改的檔案。在提交前,請進行必要的程式碼差異比較,確保只提交了必要的檔案和修改。

3. 提交資訊

請按照前面所述的規範編寫提交資訊,確保資訊的完整、準確和易於理解。

4. 提交順序

請按照提交的邏輯順序進行提交操作。如果本次提交需要依賴於其他提交,請確保其他提交已經完成並透過測試。

相關文章