-
Notifications
You must be signed in to change notification settings - Fork 3
Git Githubの開発ルール
JioShun edited this page Sep 21, 2022
·
17 revisions
- Git flowというモデルで開発を進めようと考えています。
- 提唱された記事
- 日本語で説明されてる記事
- 以上の形に沿って、今回の開発に適した形での運用を行います。
-
main
ブランチは各スプリントの成果をマージしていきます。 -
develop
ブランチは基本の開発ブランチです。ここからブランチを切って開発してください。 -
feature/#??/hoge
ブランチではdevelopブランチに追加する機能をマージしていきます。-
#??
はPBIのissue番号 -
hoge
は任意の機能名(英語のみ)
-
-
hotfixes
ブランチは緊急のバグ直しブランチです。使用頻度は高くありませんが、ステークホルダーに見せる時にやばいバグが発覚したなどがあれば使用してください。
- 内容は任せますが、そのコミットの方向性がわかるprefixをつけてください。(先頭の文字で何をやっているのかを見やすくするため)
-
wip
: WIP(Work in progress: 作業中)の時(その人の裁量に任せる) -
add
: 機能などの追加が完了した時 -
update
: orfix
: ファイルの修正などを行った時
-
- コミットメッセージはわかりやすければ基本なんでもいいです。(みんな日本語で書いてください)
- 良い例:
-
add
: ヘッダーの追加 -
wip
: スタイルの変更 -
fix
: ~のバグの修正
-
- 基本は各featureブランチからdevelopブランチにマージしたい時、つまりはfeatureブランチで開発していた機能が完成した時などにPRを出してください。
- PRでは、一人以上、できれば2人以上のコードレビューを必須にします。レビュー時のチェックすることは基本的には下記を見るようにしてください。
- 変なファイルやコードが無いか
- 関数名、変数名などが適切か
- コーディングルールを守れているか
- リーダーかPOがスプリントレビュー前にdevelopブランチからmainブランチにPRを出します。なるべく全員でコードレビューするようにしましょう。