git & GitHub 運用ルール

Megumi Hano edited this page Mar 20, 2015 · 1 revision
  • 本リポジトリは EXP のテーマディレクトリのみを管理
  • WordPress 本体を git 管理する場合には別リポジトリにて管理
  • 運用は GitHub Flow の考え方を採用する

運用方法

branch

  • master : メインブランチ
  • feature branch : サポートブランチ(= 作業用ブランチ)で、派生元は master とする

issue

  • 仕様・要件が確定したものから登録
  • バグ報告
  • 詳細はコメントにて記載
  • ラベル : design, refactor, bug, hotfix, docs, feature, priorityHigh, priorityLow
  • issue をクローズするときは、クローズコメントを簡潔に記述すること(完了したのでクローズ、他の issue に引き継ぐ等)

作業手順

  1. 各自ローカルリポジトリの master にチェックアウト
  2. git pull (新たに作業用ブランチを切る前に必ずリポジトリを最新化すること)
  3. git checkout -b <new branch name> (作業ブランチの派生元は必ず master とする)
  4. git add <file name> or git add -A
  5. git commit -m “commit message”
  6. git push
  7. プルリクエスト作成、マージ

ブランチ名の付け方

ブランチの名前は担当する issue に付与されたラベル名を冒頭につけ、以後は / (スラッシュ)で記述する

例 : $ git checkout -b "feature/coding_footer"

コミットと issue の紐付け

  • 1つの issue に対して切るブランチは1つ
  • issue がクローズまたは master にマージ後はそのブランチでは作業しない

コミットメッセージにはそのコミットがどの issue の対応をしていたのかが分かるようにするため、 issue 番号を付与し、作業内容を簡潔に記述すること

例1 : $ git commit -m “set variables at _config.scss #12”

issue 番号(#12)をクリックすると該当する issue を参照することができる

プルリクエストについて

手順(後に作成)

プルリク後のソースコードのレビュー方法

  1. ローカルで master にチェックアウト
  2. リモートブランチと同期
  3. master 上で該当するブランチをマージ $ git merge <branch name>
  4. チェック
  5. コンフリクトがなければ、OK
  6. コンフリクトがあった場合、解消してチェックの後コミット

参考

GitHub Flow

git flow

デプロイメント