コンテンツにスキップ

Git

Git の基本的なインストールについてはここでは詳しく説明しない。ここでは Git に関するその他の知識を記述する。

GPG 署名の使用

基本的なインストール後、実は面白いことができる —— 僕にとっては、Git のコミット履歴に表示される 未検証 のオレンジ色のバッジが気になったことがきっかけだった —— それは GPG を使ってコミットに署名することだ —— これによりバッジが緑色の 検証済み に変わる。

実は僕は Git で GPG 署名を使い始めたのが先で、SSH はもっと後に触れたものだ。本来なら、同じ GPG 公開鍵・秘密鍵のペアを使えるはずで、将来的には一つの鍵に統一するつもりだ。

設定方法は省略するので、各自で検索してほしい。

簡潔で明確なタイトルと慣習的なコミットタイプの使用

  • 各コミットメッセージは、主な変更を説明する短い動詞(通常は過去形)で始めるべき
  • タイトルは簡潔明瞭に、できるだけ 50 文字以内に収める
  • タイトルの後にピリオド . を付けない

例:

  • feat: 新機能

  • fix: バグ修正

  • docs: ドキュメント更新

  • style: コードフォーマット

  • refactor: コードリファクタリング

  • test: テスト

  • chore: 雑務

  • fix: Fix Login Button Alignment

  • feat: Add User Model

text
refactor: Extract Authentication Logic into Middleware

This makes the authentication logic reusable across multiple routes
and reduces duplication of code.

タイトルの大文字小文字に関する主なルールは以下の通り:

  • 最初の文字を大文字に: タイトルの最初と最後の単語は品詞に関わらず大文字にする
  • 実詞を大文字に: 名詞、代名詞、動詞、形容詞、副詞などはすべて大文字にする
  • 虚詞を小文字に: 冠詞(a, an, the)、接続詞(and, or, but)、前置詞(in, on, at, etc.)などは通常小文字だが、タイトルの最初または最後の単語の場合は大文字にする

小さく頻繁なコミットの使用

一度に多くの機能を書くことを避け、一箇所に集中し、各コミットで一つの問題を解決するか一つの機能を完成させる。これはコードレビュー、ロールバック、後のメンテナンスに役立つ。

WIP コミットを避ける

コミットが不完全な場合は、メインブランチへのプッシュを避けるべきだ。git commit --amend を使って最後のコミットを修正できる。その使い方と注意点は以下の通り:

  1. コミットメッセージの修正

    Bash
    git commit --amend
  2. コミット忘れのファイルを追加

    Bash
    git add <missing_file>
    git commit --amend
  3. 誤ってコミットしたファイルを削除

    Bash
    git rm --cached <wrong_file>
    git commit --amend

コミット履歴への影響

--amend を使用するとコミットのハッシュ値が変わる。コミットが既にリモートリポジトリにプッシュされている場合、コミット修正後は強制プッシュが必要になる

これは他の共同作業者の作業に影響を与える可能性があるため、慎重に使用する必要がある