忘れやすい Git コマンドと、守るようにしているコミット規約を記録します。
コミットの規約
メッセージの形式
コミットメッセージは、次の形式にします。
<类型>(<范围>): <简短描述>
<更详细的描述>-
種類：変更の目的や分類を表します。よく使う種類は次のとおりです。
-
feat：新しい機能 -
fix：バグの修正 -
docs：文書の更新 -
style：動作に影響しない書式や空白の変更 -
refactor：バグ修正でも機能追加でもないコードの整理 -
test：テストの追加や変更 -
ci：継続的インテグレーションの変更 -
build：ビルドシステムやパッケージングの変更 -
revert：コミットの取り消し
-
-
範囲：変更したモジュールや機能を括弧で示します。例：
feat(api),fix(login)。 -
短い説明：目的を簡潔に示します。英語では先頭を小文字にし、50 文字以内を目安にします。
-
詳しい説明：理由、解決方法、重要な点を記述します。件名との間に空行を入れます。省略可能ですが、記載を推奨します。1 行は 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 コマンド
リモート URL を変更する
git remote set-url origin <new-url>
リモートのブランチを取得する
# 同步远程仓库到main分支
git fetch origin main