README.md

learn-github-2024

演習

※以下で[~]のように説明しているところでは，入力する際は[]は含めない

1. KatLab-MiyazakiUniv/learn-github-2024をforkする

2. forkした自分のリポジトリをクローンする

$ git clone https://github.com/[githubユーザ名]/learn-github-2024.git

3. upstreamを登録する

upstreamとして親リポジトリを登録する(upstreamは後述する最新の状態の取得で使用する)

$ cd learn-github-2024
$ git remote add upstream https://github.com/KatLab-MiyazakiUniv/learn-github-2024.git

4. ローカルリポジトリで作業する

4.1. github でissueを建てる

github のissuesタブにあるNew issueをクリックしてissueを建てる
タイトルを「課題提出([自分の名前])」にして，コメントは下図のように記述する

4.2. 作業用ブランチを切る

ブランチを確認すると，現在mainブランチにいることが分かる

$ cd learn-github-2024/[自分の名前のディレクトリ]
$ git branch
* main

git switch -cで作業用ブランチを作成して移動する
git branchコマンドで確認した時に，新しく作ったブランチに*が付いていれば OK

$ git switch -c ticket-[issue番号]
$ git branch
  main
* ticket-[issue番号]

※git switchはブランチを移動するコマンドで，オプションに-cをつけることで新たにブランチを作成して移動する

4.3. 列挙体の課題ファイルをディレクトリ下に新たに追加して，.gitkeepを削除する

課題ファイルの名前はDirection.cppにしてください

4.4. 編集内容をコミットする

まず．git statusで，編集したファイル(追加・削除も含む)が赤く表示されていることを確認する

$ git status
//編集内容が表示される

編集内容をインデックスに追加する
この時，git statusで確認すると，先程の赤い表示の箇所が緑になっている

$ git add PidGain.cpp PidGain.h
$ git status
//編集内容が表示される

インデックスの内容をローカルリポジトリにコミットする

$ git commit -m "編集内容の簡潔な説明"

4.5. 自分のリモートリポジトリ(origin)にpushする

$ git push origin ticket-[issue番号]

5. KatLab のリポジトリにプルリクを出す

github で自分のリポジトリを開いて以下の手順で操作する

①Compare & pull requestをクリック

② プルリクのタイトルと内容を記述する

③ レビューしてほしい人を選択する

③Create pull requestをクリック

※プルリクのタイトルはclose #[issue番号] [プルリクの説明]とすると，該当 issue と自動で紐づけられる

6. レビューを受けて修正する

Request changeがあれば修正し，レビュワー全員からApproveをもらったらマージする

7. ローカルリポジトリのmainブランチを最新の状態に更新する

git pullコマンドを使って，親リポジトリ(upstream)から最新の状態を取得する

$ git switch main
$ git pull upstream main

mainブランチを更新出来たら，新たにブランチを切って次の作業を進める(演習はここまで)

Google Test の実行について

第 3 回では、#演習 の、3 番までを行う。

1. Dockerfile からコンテナを作成、実行

VSCode で、左下から「コンテナーを再度開く」

2. googletest/build の中身を削除し、CMake 実行

# Permission denied エラーが発生したら、以下コマンドを実行
# chmod 755 build.sh

./build.sh

3. gtest 実行

# Permission denied エラーが発生したら、以下コマンドを実行
# chmod 755 gtest_all.sh

./gtest_all.sh