Skip to content

Instantly share code, notes, and snippets.

@yousan
Created December 7, 2018 09:14
Show Gist options
  • Save yousan/b147f14d0c1d697dde6f4d4d6c857fb8 to your computer and use it in GitHub Desktop.
Save yousan/b147f14d0c1d697dde6f4d4d6c857fb8 to your computer and use it in GitHub Desktop.
Gitコミットのルールについてについて

ベース

ブランチ名の命名規則をGitFlow、マージはPRでマージさせるGitHub Flowを組み合わせて使っています。

Git-flowって何?

ブランチ名について

  1. 名前は features/yousan/201801/fix-admin-panel といった名前でブランチを作ってください。 開発用ブランチとして、features/ブランチの以下にユーザ名(例: yousan/)、年月(例: 201801)、機能概要(例: fix-admin-panel)としてください。

feature以外のブランチについて

  1. ブランチの作成はdevelopから行ってください。
  2. masterブランチ、developブランチへの直接コミットは行わないようにしてください。
  3. featureブランチの作成にはSourceTreeのGit Flowを使うと便利です。

コミットとブランチの粒度について

  1. コミットの粒度は出来る限り小さめにしてください。 目安として5ファイル、100行以下に留めるようにしてください。 時間としては1時間に1コミットぐらいを目安にしてください。 あくまで目安ですが、ブランチの粒度は1日、8時間の作業ですと1日に8コミット、1ブランチほどを目処としてください。 developブランチとの差分が大きくなると修正が大変になりますので、ブランチは長い期間空けたままにしないでください。 概ね3日を超えるとマージが大変になります。

プルリクエストについて

開発が終了したら、ブランチからdevelopに向けてプルリクエスト(PR)を作成してください。 PR作成後、yousanまでご連絡ください。

レビューについて

作成してもらったPRについて、コードレビューが入る場合があります。 細かい点などを含めて修正をお願いする場合がありますので、修正よろしくお願いします。

CIについて

GitHubへのプッシュを行うと、自動テストを走らせるCIが通ります。 原則として、PRの際にCIが成功している必要があります。 CI失敗の場合には修正をお願いします。

コミットメッセージについて

コミットメッセージは日本語、英語、どちらでも大丈夫です。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment