Skip to content

開発の流れ

YuyaKimura edited this page Jun 7, 2024 · 3 revisions

開発の流れ

全体の流れ

  1. ZenHubでチケットを発行する
  2. ZenHubでチケットをInProgressに移動する
  3. 最新のetrobocon2024を取り込む
  4. 担当するチケットの作業用のブランチを作成する
  5. 実装する/テストコードを書く
  6. テストを実行する
  7. git add/commitする
  8. プルリクエスト用のブランチを作成してpushする
  9. プルリクを出す
  10. レビューを受ける/修正する
  11. プルリクをマージする

1. ZenHubでチケットを発行する

  1. Issueタイトルを書く
  2. Templateに従って,完了条件と関連資料(省略可)を書く
  3. Assigneesで,チケットの担当者を設定する
  4. Milestoneで,今回のイテレーションを選択する
  5. Estimateで,ミーティングで見積もりをしたチケットの重みを選択する
スクリーンショット 2021-05-21 17 53 44

2. ZenHubでチケットをInProgressに移動する

InProgressにドラッグアンドドロップ

3. 最新のetrobocon2023を取り込む

$ cd ~/etrobo/workspace/etrobocon2024
$ git switch main
$ git pull origin main

4. 担当するチケットの作業用のブランチを作成する

ブランチを作成・移動する.ブランチ名は「work-X」とし,XはZenHubのチケット番号とする.

$ git switch -c work-X main

5. 実装する/テストコードを書く

頑張る.コーディング規約に従って実装をする.
※ビルドが通ることは必ず確認する.
※ビルドが通っていないということは,バグとか以前に実装ができていないということ.

ビルド方法はREADME.mdを参照.

6. テストを実行する

~/etrobo/workspace/etrobocon2024で実行する

$ ./gtest_all.sh

7. git add/commitする

$ git add 変更したファイル名1.h 追加したファイル名2.cpp
$ git status
$ git commit -m "変更内容の簡潔な説明"

ここでは自由にコミットしていい(8.で1つにまとめる).

8. プルリクエスト用のブランチを作成してpushする

作業ブランチでコミットした内容を,プルリクエスト用のブランチにまとめる

# ブルリクエスト用ブランチを作成・移動する.
$ git switch -c ticket-X main

# 作業用ブランチの変更内容を,ticket-Xに反映させる
$ git merge --squash work-X

# コミットしてpushする
$ git commit -m "変更内容の簡潔な説明"
$ git push origin ticket-X

コミットのコメントは、変更に応じて

  • add: 新規に追加した内容
  • update: 更新した内容
  • fix: (バグなどを)修正した内容
  • delete: 削除した内容
  • refactor: 処理には影響がないが可読性を高めるための内容

を使い分ける。

※コミットを複数に分けたい場合は,git reset HEAD file_nameで一旦addを取り消してコミットする. (コミットはgit statusをした時に緑色になっているファイル変更のみ適用される) コミット後に再度addしてcommitすればよい.

9. プルリクを出す

本リポジトリの自分がpushしたブランチから,プルリクを出す. プルリクのタイトルは,「close #チケット番号 チケットのタイトル」とする.

  1. のチェックリストを確認し,変更点を記述する.
  2. でレビューして欲しい人を選択する.この時,et2024を選択すると,チームの全員を指定できる.
  3. でテストが成功していることを確認する.
  4. でプルリクとチケットを連結させる.

スクリーンショット 2020-07-21 10 53 00
スクリーンショット 2020-07-21 10 53 44

10. レビューを受ける/修正する

手順5~9を繰り返す.pushするだけでプルリクに反映される.

11. プルリクをマージする

規定以上のメンバーからApproveをもらえたら,マージする.