Skip to content

Git Rules

Takeru Miki edited this page Jan 18, 2021 · 1 revision

コミットメッセージ

(vimで書いて欲しいな)

  1. prefixを書く
  • feat: 新しい機能
  • fix: バグの修正
  • docs: ドキュメントのみの変更
  • style: 空白、フォーマット、セミコロン追加など
  • refactor: 仕様に影響がないコード改善(リファクタ)
  • perf: パフォーマンス向上関連
  • test: テスト関連
  • chore: ビルド、補助ツール、ライブラリ関連
  1. issue番号を書く
  2. 変更内容を書く(大文字動詞から始める)
  3. 理由をかく(コミットvimで開いて3行目から書く、大文字で始める)

例:issue番号14で、新しく並び替えをするためにイベントのコレクションにorderフィールドを追加した時

1 feat: #14 Add order field into event collections
2 
3 To sort talks at Event.vue

issueがない時は書かない

ブランチ名

  1. ブランチの種類
  • master 公開中の安定版
  • dev-v1 バージョンごとのdevelop(左はバージョン1の例) 派生元:master
  • refactor 仕様に影響のないコード改善 派生元:dev(or master以外)
  • fix bugの修正 派生元:dev(or master以外)
  • feature 新機能の実装 派生元:dev(or master以外)
  • try 新しい技術のお試しブランチ 派生元:dev(or master以外)
  • hotfix 公開中のバグ修正 派生元:master
  1. issue番号(#1)
  2. 詳しい説明(スペースは_で繋げる)

例:issue番号113のブランチ、GoogleAuth非同期処理のthenをawaitに置き換える
-> refactor/#113_replace_then_with_async

Clone this wiki locally