開発の流れ - KatLab-MiyazakiUniv/etrobocon2020 GitHub Wiki
前提
README.mdに従って以下の作業を行っている。
- etrobocon2020をForkした
- Fork先のetrobocon2020(自分のGitHubアカウントのetrobocon2020、以下originとよぶ)をcloneした
- Fork元のetrobocon2020(KatLab-MiyazakiUnivのetrobocon2020、以下upstreamとよぶ)をupstreamとして登録した
開発の流れ
全体の流れ
- ZenHubでチケットを発行する
- ZenHubでチケットをInProgressに移動する
- 最新のetrobocon2020を取り込む
- 担当するチケット用のブランチ(例：ticket-1)を作成する
- 実装する
- テストコードを書く
- テストを実行する
- git add/commitする
- originにチケット用ブランチ(ticket-1)をpushする
- プルリクを出す
- レビューを受ける/修正する
ZenHubでチケットを発行する
後で書く
ZenHubでチケットをInProgressに移動する
後で書く、ドラッグアンドドロップ
最新のetrobocon2020を取り込む
$ git checkout master
$ cd ~/etrobo/workspace/etrobocon2020
$ git pull upstream master
担当するチケット用のブランチ(例：ticket-1)を作成する
masterブランチにいることを確認する(masterに*が付いていればOK)
$ git branch
ブランチを作成・移動する。ブランチ名は「ticket-X」とし、XはZenHubのチケット番号とする。 ここでは、チケット番号1のブランチを作成している。
$ git checkout -b ticket-1
実装する/テストコードを書く
頑張る。コーディング規約に従う。ビルド方法はREADME.mdを参照。
テストを実行する
~/etrobo/workspace/etrobocon2020で実行する
$ ./gtest_all.sh
git add/commitする
$ git add 変更したファイル名1.h 追加したファイル名2.cpp
$ git status
$ git commit -m "変更内容の簡潔な説明"
originにチケット用ブランチ(ticket-1)をpushする
$ git push origin ticket-1
プルリクを出す
自分のGitHubアカウントのetrobocon2020(Fork先)から、プルリクを出す。
プルリクのタイトルは、「close#1 チケットのタイトル」とする。
①のチェックリストを確認し、変更点を記述する。
②でレビューして欲しい人を選択する。
③でテストが成功していることを確認する。
④でプルリクとチケットを連結させる。
レビューを受ける/修正する
手順5〜9を繰り返す。pushするだけでプルリクに反映される。
プルリクをマージする
2人以上のメンバーからApproveをもらえたら、マージする。