1
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 3 years have passed since last update.

Gitコマンドを使ってGitHubにPullRequestするまでを細かく書き出した

Posted at

フィヨルドブートキャンプ受講生の方向けに書いたので、初学者向けです。
お困りの方の参考になれば幸いです :pray:

1. ブランチを作成する

まず、変更を適用するためのブランチを作成します。
ブランチは大抵の場合は 本流のブランチ(main もしくは master)から伸ばすことが多いかなと思います。
例えば「test_branch」という名前のブランチを作成したい場合は、
$ git switch -c test_branch
で、ブランチの作成と切り替えを同時に行うことができます。-c は create の c と覚えると良さそうです。
$ git branch コマンドで、今どんなブランチがあるか・現在どのブランチを参照しているかを把握することができます。

1_create.png

2. ファイル内容を変更する

test_branch を参照している状態で、ファイルを変更します。
変更の内容は
$ git status (どのファイルが変更されているかをチェック)、
$ git diff (ファイルの変更内容をチェック)
を使いつつ確認できます。
特定のファイルの変更のみ確認したい時は $ git diff test.txt などファイル名を指定します。

2_diff.png

3. 変更のうち、何をコミットするか決める(ステージング)

複数変更があっても、コミットする内容を取捨選択することができます。"コミットする予定"の状態をステージングといいます。コミットしたいファイルを
$ git add test.txt
でステージングに追加します。
ステージングの状況は $ git status で確認できます。「Changes to be commited:」の欄にtest.txtが入り、コミットされる予定になっていることがわかります。
3_add.png

4. コミットする

$ git commit -m "コミットコメント" でコミットできます。
コミットコメントはただの「変更しました」などではなく、その変更内容を表す説明をしっかり記述しましょう
vimやemacsの操作に慣れていれば、 -m オプションなしで複数行書くモードにしても良いでしょう。
コミットコメントの書き方については、プロジェクトによってルールが決まっていることがあるケースもあるでしょう。詳しくは、多くの方がいっぱい記事をかいているので説明はそちらにおまかせします。
Gitのコミットメッセージの書き方 - Qiita
僕が考える最強のコミットメッセージの書き方 - Qiita
誰にとってもわかりやすいGitのコミットメッセージを考える | Tips Note by TAM

練習としては、一旦、「未来の自分がわかる」レベル感で書いておくと良いと思います。

$ git status を前後に実行すると、ステージングされたファイルがコミットされて変更内容とみなされなくなったことがわかります。
commitの記録は $ git log で確認できます。

4_commit.png

5. リモートリポジトリへpushする

前提としてpush先の登録はすでにあるものとします。cloneすればすでに登録は済んだ状態で開始できてるはず、そうでなければ $ git remote add origin が必要かなと思います。詳しい説明は省略します :bow:
リポジトリをクローンする - GitHub Docs
Githubに新規リポジトリを追加 - Qiita

今登録されているリモートリポジトリを確認するには $ git remote -v とします。
変更を入れたブランチ test_branch は、
$ git push origin test_branch
でリモートリポジトリ(今回の場合GitHub)へpushすることができます。

ここで使用されている origin は、 remote -v の時に表示されたリモートリポジトリ登録名を指しています。
pushしたら、CUI (コンソール) での操作はおしまいです。

5_push.png

6. GitHubでPull requestを作る

push時に次のような案内もありましたので、GitHubにアクセスしてみましょう。

remote: Create a pull request for 'test_branch' on GitHub by visiting:
remote:      https://github.com/betachelsea/git-test/pull/new/test_branch

案内されたURLにそのまま飛んでも良いです。
もしくは、GitHubの該当リポジトリを見に行くと黄色枠で新しくpushされたブランチについて表示されています。
「Compare & pull request」のボタンを押すと、上記と同じURLに遷移します。

6_1_github_top.png

「Open a pull request」の画面になったら、Pull requestのタイトル、説明を記入します。
参考画像ではあんまりにも中身がないのでスッカスカのタイトル、説明ですが、実際の開発現場ではレビュアーのためにももっと詳しく書きましょう。

6_2_pullrequest.png

「Create pull request」ボタンを押すと、Pull request が作成されます。

6_3_pullrequest.png

extra 色々できます

若干発展的なので追々、と思いつつ、Gitは痒いところにも手が届くよ〜ということをアピールします。
他にも色々あるので、困ったら「何かしらできるはず」と思って調べていただくと良いかなと思います。

ステージング済みの変更内容を確認したい

$ git diff --cached で確認できます。

やっぱりこのファイルのコミットをやめたい(ステージングの取り消し)

$ git restore --staged test.txt でやめられます。
(git status するとメッセージに案内がありますね。)

ファイルの変更内容のうち一部だけコミットしたい

$ git add -p test.txt で選べます。
ややこしいので詳しくは他の解説記事におまかせします!
Git - 対話的なステージング
横着で神経質な私とあなたに贈るgit add -p - Qiita
git add -p 使ってますか? - Qiita
git add -pのすゝめ - DEV Community

困った時はメッセージを読む

Git、都度出てくるメッセージを読むと「このコマンドを使え!」という案内が出ているので、なにかうまくいかないことがあったら、一旦深呼吸して英語を読むとすぐ解決できたりします。

がんばっていきましょう :muscle:

1
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?