記錄一下自己使用git容易忘記的指令和要學習遵守提交規範
git提交規範
提交資訊格式
每次提交應遵循以下格式：
<类型>(<范围>): <简短描述>
<更详细的描述>-
型別：提交的型別，表示本次提交的目的或類別，常見的型別包括：
-
feat：新特性（feature） -
fix：修復 bug -
docs：文件相關更新 -
style：程式碼風格的調整（空格、格式化等，不影響程式碼功能） -
refactor：重構（既不修復 bug 也不新增新特性） -
test：增加或修改測試程式碼 -
ci：持續整合相關的修改 -
build：構建系統（如打包工具等） -
revert：回退提交
-
-
範圍：提交影響的模組或功能範圍，對專案的哪個模組或者功能進行了修改，用圓括號括起來。例如：
feat(api),fix(login)。 -
簡短描述：簡潔明瞭地描述本次提交的目的，首字母小寫，不超過 50 個字元。
-
詳細描述：對提交的詳細描述，包括原因、解決方案、關鍵點等。詳細描述與簡短描述之間空一行，內容可選但推薦提供，最大長度可以是 72 字元。
提交資訊示例
-
feat(user-auth): add login API -
fix(api): fix invalid username validation -
docs(readme): update setup instructions -
refactor(auth): improve password hashing algorithm -
test(user): add unit tests for login functionality -
chore(deps): update dependency versions
提交時的注意事項
-
避免：
-
使用模糊不清的提交資訊，如
fix,update,change等。 -
提交過大的改動，建議將大改動拆分成多個小的提交。
-
直接修改程式碼邏輯的提交沒有詳細描述。
-
-
務必：
-
保持提交資訊簡潔且有意義，能清晰地告訴他人此次修改的意圖。
-
每次提交前，請確保程式碼能夠成功編譯並透過測試，避擴音交未透過測試的程式碼。
-
demo
git add . # 添加修改的文件到暂存区
git commit -m "feat(user-auth): add login API" # 提交代码并写简短描述
git push origin main # 推送到远程仓库# 新特性
git commit -m "feat(auth): 添加用户api"
# 修复 bug
git commit -m "fix(validation): ..."
# 代码重构
git commit -m "refactor(user): ...."
# 添加测试
git commit -m "test(user): 为登录添加单元测试"
# 文档更新
git commit -m "docs(readme): 更新安装指南"
git常用指令
修改遠端倉庫地址
git remote set-url origin <new-url>
同步遠端倉庫分支
# 同步远程仓库到main分支
git fetch origin main