主要な Git の概念
Repository
Repository
すべてのファイルとその履歴が保存される、ドキュメントのソースです。ウェブエディタはコンテンツにアクセス・編集するために、リポジトリに接続します。
Commit
Commit
特定の時点での変更を保存したスナップショットです。各コミットには変更内容を説明するメッセージが含まれ、プロジェクト履歴に恒久的な記録が作成されます。
Branch
Branch
ブランチは、リポジトリ内の特定のコミットを指します。公開中のドキュメントはデプロイ用ブランチからビルドされます。公開にはまだ反映していない変更を持つブランチを、いくつでも作成できます。ブランチの変更を公開中のドキュメントに取り込むには、プルリクエストを通じてデプロイ用ブランチにマージします。ブランチを使うことで、公開中のドキュメントに影響を与えずに作業でき、新機能を安全に試し、公開前にレビューを受けられます。
Deployment branch
Deployment branch
公開中のドキュメントがビルドされる、プロジェクトの主なブランチです。このブランチへの変更は自動的にドキュメントサイトへ公開されます。一般的には
main
と呼ばれますが、どのブランチでもデプロイ用ブランチとして設定できます。Pull request
Pull request
ブランチ上の変更を公開中のドキュメントにマージするための提案です。変更が公開される前に、レビューと議論を行えます。一般に PR と呼ばれ、GitLab では merge request とも呼ばれます。
Diff
Diff
diff(差分)は、ファイルの2つのバージョン間の変更点を示します。プルリクエストをレビューする際、差分は追加・削除・変更された箇所を強調表示し、何が変わったかを簡単に把握できます。
ウェブエディタが Git を使うしくみ
- ファイルを開く: エディタがリポジトリから最新の版を取得し、常に最新のコンテンツで作業できます。
- 変更を加える: エディタが変更を下書きとして追跡し、保存の準備ができたらコミットにできます。
- 変更を保存する: エディタが変更をコミットし、プロジェクトの履歴に保存します。
- ブランチを作成する: エディタがリポジトリに新しいブランチを作成します。リポジトリにアクセスできるユーザーなら誰でも、そのブランチで共同作業やレビューができます。
- デプロイ用ブランチに公開する: エディタがデプロイ用ブランチに直接コミットしてプッシュし、変更を即時に公開します。
- その他のブランチに公開する: エディタがプルリクエストを作成し、デプロイ用ブランチにマージする前に他のメンバーからフィードバックを得られるようにします。
Git のベストプラクティス
- わかりやすいコミットメッセージを書く: 何をどう変えたかを、能動的で具体的に記述します。
- 意味のあるブランチ名を使う: 進めている作業内容が伝わり、リポジトリのブランチ一覧を見ても意図がわかる名前にします。
- ブランチの目的を明確にする: そのブランチでの変更は特定のタスクやプロジェクトに絞ります。
- マージ後はブランチを削除する: リポジトリを整理するため、不要になったブランチは削除します。