Github超基本の使い方
Githubでレビューを受ける立場になった為、プルリクエストをする機会が増えました。
使いこなせては居ないですが、初心者が最低限出来ている事をまとめてます。
いつも操作する際は下記流れを表示させ、確認しながら行っています。。
GIT実践の流れ
リモートリポジトリのデータを取得する
git clone
ブランチを作成する
git branch ブランチ名
ブランチに移動する
git checkout ブランチ名
ワークツリー(作業スペース)からインデックス(更新ファイル場所)へ移動させる
コミットするファイルをインデックスに追加する
git add ファイル名(追加)git rm ファイル名(削除)
変更をコミットする(削除したファイルも)
git commit ファイル名 -m "コメント"
その他 使用したコマンド
git statusで状況確認可能 git log で履歴確認可能
リモートリポジトリへプッシュする
git push origin HEAD
プルリクエスト実行する。注意点下記
-
変更の目的を明確にする
具体的に、どのような問題を解決しようとしているのか、またはどのような機能追加を提案しているのかを説明する。 -
コードの品質を確認する
プルリクエストを出す前に、コードの品質を確認することが必要です。具体的には、コーディング規約に従っているか、コメントが適切に付与されているか、またはテストが十分に実行されているかなどを確認する。。 -
変更内容を適切に分割する
大規模な変更を提案する場合、変更内容を適切に分割することが重要です。
レビュアーの方より言われたのは、複数変更がある場合はcommitを分けてpush
した方が確認しやすいとのことでした。そうすることにより、変更の理解やレビューが容易になります。 -
レビュアーに対して丁寧なコミュニケーションを心がける
プルリクエストには、レビュアーが必ずつきます。レビュアーに対しては、丁寧なコミュニケーションを心がけることが大切です。具体的には、レビューに対する返信を早急に行い、問題点に対して的確に対処することが必要です。
GitHub上からプルリクエストに対するマージ、ブランチ削除
mainに移動する
Git checkout origin main
GitHubの内容をローカルに取り込み
git pull origin main
ローカルリポジトリのブランチを削除する
git branch -d ブランチ名