Open4

最近ちゃんとGitを触り始めたので、Gitコマンド、略語、ブランチをまとめる

shiorinashiorina

git add.

git add .

このコマンドは、現在のディレクトリ（.は現在のディレクトリを指す）およびそのサブディレクトリにあるすべての変更されたファイル、新しいファイル、削除されたファイルをステージングエリア（インデックス）に追加するために使用されます。ステージングエリアとは、Gitでコミットする前にファイルの変更を一時的に保存する場所です。
このコマンドを使用することで、次にgit commitを実行したときに、これらの変更がリポジトリの歴史に記録されます。つまり、git add .を使うことで、プロジェクトの現在のディレクトリ下の全ての変更を次のコミットに含める準備をすることができるのです。

git commit -m '変更内容'

git commit -m '変更内容'

このコマンドは、Gitで変更をリポジトリに記録するためのものです。このコマンドの -m オプションは「メッセージ」を意味し、その後に続くクォーテーション（' '）内にはコミットメッセージを記入します。

コミットメッセージは、そのコミットで行った変更の内容や意図を簡潔に説明するために使われます。これにより、プロジェクトの履歴を追いやすくなり、他の開発者が変更内容を理解しやすくなります。

git branch -a

git branch -a

ローカルとリモートの両方に存在するすべてのブランチを表示するために使われます。このコマンドを実行すると、現在のリポジトリに関連付けられているすべてのブランチのリストが表示されます。
-a オプション: これは "all"（すべて）を意味し、ローカルブランチだけでなく、リモートリポジトリにあるブランチも含めてすべて表示します。
出力例
実行すると、次のような出力が得られることがあります（ブランチ名は例です）：

  main
* feature/new-ui
  remotes/origin/HEAD -> origin/main
  remotes/origin/main
  remotes/origin/feature/new-ui

ここで、remotes/origin/ という接頭辞がついているブランチはリモートリポジトリに存在するブランチを指し、それ以外はローカルリポジトリに存在するブランチです。

このコマンドは、どのブランチが存在しているのか、またどのブランチが現在アクティブか（通常は星印 * が付いている）を確認する際に役立ちます。リポジトリのブランチ状況を一覧できるため、チーム開発や複数のブランチを管理している時に特に便利です。

git push origin branch-name

git push origin <branch-name>

このコマンドは、指定したローカルブランチの変更をリモートリポジトリ（この場合は origin）の同じ名前のブランチにプッシュするために使います。ここで <branch-name> はプッシュしたいローカルブランチの具体的な名前です。
例:feature/new-ui ブランチをプッシュする場合

git push origin feature/new-ui

git switch main

 git switch main

このコマンドは、Gitで現在のブランチから main ブランチに切り替えるために使用されます。このコマンドは比較的新しく、古い git checkout コマンドの代わりに導入されました。git switch コマンドは、ブランチ間の移動をより明確にすることを目的としています。

git pull origin main

git pull origin main

このコマンドは、Gitで使われる一般的なコマンドで、リモートリポジトリ（この場合は origin）から特定のブランチ（ここでは main）の最新の変更を取得して現在のローカルブランチに統合します。このコマンドは、実際には git fetch に続いて git merge を行う操作を一つのコマンドで実行するものです。

git switch -c new-branch-name

git switch -c <branch-name>

このコマンドは、新しいブランチを作成してそのブランチに切り替えるために使用されます。ここで <branch-name> は新しいブランチの名前です。このコマンドは、git checkout -b <branch-name> の代わりとして導入されたもので、ブランチの操作をより明確に行うためのものです。

shiorinashiorina

Pull Requestで使う略語

略語 意味
LGTM 「Looks Good To Me（私はOKだよ）」の略。成果物（コードなど）のレビューをお願いされたり、資料のサマリを確認を行った際に、レビュアーが特別問題がないと判断した場合に使います。
SSIA 「Subject Says It All（件名通りだよ=タイトルみればわかる）」の略。
WIP 『今、対応中です』という意味。Work In My Progress　の略
FYI 「For Your Information（ご参考までに）」の略。参考資料やサイトURLを送るときに[FYI] という言葉を付けたりします。
SSSIA 「Subject and Screenshot Says It All（件名と画面キャプチャ通りだよ」の略。
AFAIK 「As Far As I Know（自分が知っている限りでは）」の略。
RFC "Request For Comments" の略で、他の開発者に意見やフィードバックを求めるときに使います。
PTAL "Please Take Another Look" の略で、一度レビューされた後、指摘された部分を修正して再度レビューを求める際に使います。
FYI "For Your Information" 『参考までに』の略で、情報提供のみを目的としているときに使います。これはプルリクエストのマージを直接求めるものではなく、参考情報として提供する場合に使用されます。
TBD 「To Be Determined（あとで決める）」の略。
shiorinashiorina

git remote

git remote

git remote

このコマンドは、設定されているリモートリポジトリの名前の一覧を表示します。

git remote -v

git remote -v

-v オプション（verboseの略）を付けることで、各リモートリポジトリのフェッチ（fetch）とプッシュ（push）のURLも表示されます。

リモートを追加、削除、名前変更

新しいリモートを追加

git remote add <remote-name> <url>

ここで <remote-name> は新しいリモートリポジトリの名前、<url> はそのURLです。例えば、GitHubのリポジトリを追加する場合、以下のようになります：

git remote add origin https://github.com/user/repo.git

リモートの名前を変更

git remote rename  [変更前リポジトリ名] [変更後リポジトリ名]

リモートを削除

git remote rm  [削除したいリモートリポジトリ名]

リモートのURLを変更

git remote set-url origin [変更先のURL]
shiorinashiorina

ブランチの命名規則

main

本番環境モジュールのブランチ。
本番環境と同じ状態に保っておき、リリース後にタグ付けを行います。
このブランチに対し、直接ソースコードを変更しpushするようなモジュールへの変更は行いません。

develop

開発用のブランチ。開発したモジュールを集合させるブランチです。
このブランチからfeatureブランチを切って開発を行います。
このブランチに対し、直接ソースコードを変更しpushするようなモジュールへの変更は行いません。

feature

機能追加用のブランチ。
develop からブランチ作成し、 develop にマージします。
複数の機能を開発する場合や複数人で開発を行う場合には、このブランチを複数作成します。

hotfix

リリース後の緊急対応用ブランチ。
緊急のバグ対応など、現在の本番環境に対して緊急の変更が必要な場合に作成します。
mainからブランチ作成し、mainにマージします。
mainにマージする際に、mainにタグをつけます。
(例:Tag 1.1)
本番リリース後、developへマージします

release

リリースの準備用のブランチ。 リリース予定の機能やバグフィックスが反映された状態(綺麗な状態)のdevelopからブランチ作成します。
リリース準備が整ったら、 mainにマージします。
mainにマージする際に、mainにタグをつけます。
(例:Tag 2.0)
releaseに修正があった場合は、developにもマージします。
developには頻繁にマージが行われるので、リリース用のモジュールを固めるため、releaseブランチを独立させます。 そうすることで、mainとの間にワンクッション置くことができ、mainへリリース対象外の修正が混入することを防ぐことができます。